docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html
index 68f8d01..66fe9f4 100644
--- a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html
+++ b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html
@@ -99,7 +99,7 @@
<code><a href="#getVulnerabilitySummary">getVulnerabilitySummary(parent, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a summary of the number and severity of occurrences.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists occurrences for the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -126,115 +126,145 @@
{ # Request to create occurrences in batch.
"occurrences": [ # Required. The occurrences to create. Max allowed length is 1000.
{ # An instance of an analysis type that has been found on a resource.
- "remediation": "A String", # A description of actions that can be taken to remedy the note.
"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
- "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
+ "longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. 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).
- "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.
- "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
},
],
- "longDescription": "A String", # Output only. A detailed description of this vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
- "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
"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.
},
- "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
- "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
"build": { # Details of a build occurrence. # Describes a verifiable build.
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. 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.
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.
- "projectId": "A String", # ID of the project.
- "id": "A String", # Required. Unique identifier of the build.
+ "logsUri": "A String", # URI where any logs for this provenance were written.
+ "startTime": "A String", # Time at which execution of the build was started.
"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.
"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",
],
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
- "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
},
],
+ "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"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",
},
- "endTime": "A String", # Time at which execution of the build was finished.
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
- "id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
- "waitFor": [ # The ID(s) of the command(s) that this command depends on.
- "A String",
- ],
- "dir": "A String", # Working directory (relative to project source root) used when running this command.
- "args": [ # Command-line arguments used when executing this command.
- "A String",
- ],
"name": "A String", # Required. 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`.
"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.
+ "args": [ # Command-line arguments used when executing this command.
+ "A String",
+ ],
+ "waitFor": [ # The ID(s) of the command(s) that this command depends on.
+ "A String",
+ ],
+ "dir": "A String", # Working directory (relative to project source root) used when running this command.
},
],
- "startTime": "A String", # Time at which execution of the build was started.
+ "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.
+ "builderVersion": "A String", # Version string of the builder at the time this build was executed.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
+ "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.
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
+ "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.
+ },
+ "revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
+ },
+ },
"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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
"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.
- "name": "A String", # The alias name.
"kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
+ "name": "A String", # The alias name.
},
"revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
},
},
],
@@ -248,69 +278,84 @@
],
},
},
- "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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
- },
- "revisionId": "A String", # A revision ID.
- },
- },
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
},
+ "projectId": "A String", # ID of the project.
"createTime": "A String", # Time at which the build was created.
- "builderVersion": "A String", # Version string of the builder at the time this build was executed.
- "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
- "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.
- "logsUri": "A String", # URI where any logs for this provenance were written.
+ "id": "A String", # Required. Unique identifier of the build.
+ "endTime": "A String", # Time at which execution of the build was finished.
},
},
- "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
- "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
- "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
+ "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.
+ "createTime": "A String", # Output only. The time this occurrence was created.
+ "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
+ "signatures": [
+ { # A signature object consists of the KeyID used and the signature itself.
+ "keyid": "A String",
+ "sig": "A String",
+ },
+ ],
+ "signed": { # This corresponds to an in-toto link.
+ "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
"A String",
],
- "userEmail": "A String", # Identity of the user that triggered this deployment.
- "platform": "A String", # Platform hosting this deployment.
- "address": "A String", # Address of the runtime element hosting this deployment.
- "undeployTime": "A String", # End of the lifetime of this deployment.
- "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
- "config": "A String", # Configuration used to create this deployment.
+ "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
+ "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
},
},
- "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+ "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
+ "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
+ "location": [ # Required. 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`.
+ "path": "A String", # The path from which we gathered that this package/version is installed.
+ "version": { # Version contains structured information about the version of a package. # The version installed at this location.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ },
+ ],
+ "name": "A String", # Output only. The name of the installed package.
+ },
+ },
"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.
+ "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
+ "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
+ "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.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. 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.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
"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.
@@ -318,111 +363,66 @@
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
},
],
- "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
- "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
},
},
- "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
- "signatures": [
- { # A signature object consists of the KeyID used and the signature itself.
- "sig": "A String",
- "keyid": "A String",
+ "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
+ "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 authority 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). # Required. Attestation for the resource.
+ "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. # A PGP signed attestation.
+ "signature": "A String", # Required. 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.
+ "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 hexidecimal 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`.
+ "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).
},
- ],
- "signed": { # This corresponds to an in-toto link.
- "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
- "customValues": {
- "a_key": "A String",
- },
+ "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
+ "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
+ "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).
+ "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
+ { # 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).
+ "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
+ "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
+ },
+ ],
},
- "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
+ },
+ },
+ "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
+ "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
+ "userEmail": "A String", # Identity of the user that triggered this deployment.
+ "address": "A String", # Address of the runtime element hosting this deployment.
+ "config": "A String", # Configuration used to create this deployment.
+ "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
- "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
- "customValues": {
- "a_key": "A String",
- },
- },
- "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
- "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
+ "platform": "A String", # Platform hosting this deployment.
+ "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
+ "undeployTime": "A String", # End of the lifetime of this deployment.
},
},
+ "remediation": "A String", # A description of actions that can be taken to remedy the note.
+ "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
+ "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
+ "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
+ "type": "A String", # Required. The type of hash that was performed.
+ "value": "A String", # Required. The hash value.
+ },
+ "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
+ },
"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.
- "analysisStatus": "A String", # The status of discovery for the resource.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "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 is output only and populated by the API.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
},
},
},
- "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
- "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 authority 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). # Required. Attestation for the resource.
- "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
- "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
- "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
- { # 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).
- "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
- "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
- },
- ],
- "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).
- },
- "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. # A PGP signed attestation.
- "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 hexidecimal 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", # Required. 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.
- "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).
- },
- },
- },
- "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
- "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
- "type": "A String", # Required. The type of hash that was performed.
- "value": "A String", # Required. The hash value.
- },
- "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
- "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
- },
- "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
- "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
- "location": [ # Required. 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`.
- "version": { # Version contains structured information about the version of a package. # The version installed at this location.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "cpeUri": "A String", # Required. 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.
- },
- ],
- "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.
- "createTime": "A String", # Output only. The time this occurrence was created.
},
],
}
@@ -438,115 +438,145 @@
{ # Response for creating occurrences in batch.
"occurrences": [ # The occurrences that were created.
{ # An instance of an analysis type that has been found on a resource.
- "remediation": "A String", # A description of actions that can be taken to remedy the note.
"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
- "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
+ "longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. 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).
- "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.
- "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
},
],
- "longDescription": "A String", # Output only. A detailed description of this vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
- "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
"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.
},
- "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
- "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
"build": { # Details of a build occurrence. # Describes a verifiable build.
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. 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.
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.
- "projectId": "A String", # ID of the project.
- "id": "A String", # Required. Unique identifier of the build.
+ "logsUri": "A String", # URI where any logs for this provenance were written.
+ "startTime": "A String", # Time at which execution of the build was started.
"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.
"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",
],
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
- "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
},
],
+ "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"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",
},
- "endTime": "A String", # Time at which execution of the build was finished.
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
- "id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
- "waitFor": [ # The ID(s) of the command(s) that this command depends on.
- "A String",
- ],
- "dir": "A String", # Working directory (relative to project source root) used when running this command.
- "args": [ # Command-line arguments used when executing this command.
- "A String",
- ],
"name": "A String", # Required. 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`.
"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.
+ "args": [ # Command-line arguments used when executing this command.
+ "A String",
+ ],
+ "waitFor": [ # The ID(s) of the command(s) that this command depends on.
+ "A String",
+ ],
+ "dir": "A String", # Working directory (relative to project source root) used when running this command.
},
],
- "startTime": "A String", # Time at which execution of the build was started.
+ "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.
+ "builderVersion": "A String", # Version string of the builder at the time this build was executed.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
+ "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.
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
+ "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.
+ },
+ "revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
+ },
+ },
"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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
"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.
- "name": "A String", # The alias name.
"kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
+ "name": "A String", # The alias name.
},
"revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
},
},
],
@@ -560,69 +590,84 @@
],
},
},
- "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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
- },
- "revisionId": "A String", # A revision ID.
- },
- },
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
},
+ "projectId": "A String", # ID of the project.
"createTime": "A String", # Time at which the build was created.
- "builderVersion": "A String", # Version string of the builder at the time this build was executed.
- "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
- "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.
- "logsUri": "A String", # URI where any logs for this provenance were written.
+ "id": "A String", # Required. Unique identifier of the build.
+ "endTime": "A String", # Time at which execution of the build was finished.
},
},
- "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
- "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
- "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
+ "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.
+ "createTime": "A String", # Output only. The time this occurrence was created.
+ "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
+ "signatures": [
+ { # A signature object consists of the KeyID used and the signature itself.
+ "keyid": "A String",
+ "sig": "A String",
+ },
+ ],
+ "signed": { # This corresponds to an in-toto link.
+ "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
"A String",
],
- "userEmail": "A String", # Identity of the user that triggered this deployment.
- "platform": "A String", # Platform hosting this deployment.
- "address": "A String", # Address of the runtime element hosting this deployment.
- "undeployTime": "A String", # End of the lifetime of this deployment.
- "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
- "config": "A String", # Configuration used to create this deployment.
+ "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
+ "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
},
},
- "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+ "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
+ "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
+ "location": [ # Required. 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`.
+ "path": "A String", # The path from which we gathered that this package/version is installed.
+ "version": { # Version contains structured information about the version of a package. # The version installed at this location.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ },
+ ],
+ "name": "A String", # Output only. The name of the installed package.
+ },
+ },
"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.
+ "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
+ "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
+ "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.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. 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.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
"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.
@@ -630,111 +675,66 @@
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
},
],
- "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
- "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
},
},
- "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
- "signatures": [
- { # A signature object consists of the KeyID used and the signature itself.
- "sig": "A String",
- "keyid": "A String",
+ "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
+ "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 authority 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). # Required. Attestation for the resource.
+ "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. # A PGP signed attestation.
+ "signature": "A String", # Required. 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.
+ "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 hexidecimal 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`.
+ "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).
},
- ],
- "signed": { # This corresponds to an in-toto link.
- "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
- "customValues": {
- "a_key": "A String",
- },
+ "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
+ "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
+ "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).
+ "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
+ { # 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).
+ "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
+ "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
+ },
+ ],
},
- "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
+ },
+ },
+ "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
+ "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
+ "userEmail": "A String", # Identity of the user that triggered this deployment.
+ "address": "A String", # Address of the runtime element hosting this deployment.
+ "config": "A String", # Configuration used to create this deployment.
+ "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
- "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
- "customValues": {
- "a_key": "A String",
- },
- },
- "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
- "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
+ "platform": "A String", # Platform hosting this deployment.
+ "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
+ "undeployTime": "A String", # End of the lifetime of this deployment.
},
},
+ "remediation": "A String", # A description of actions that can be taken to remedy the note.
+ "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
+ "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
+ "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
+ "type": "A String", # Required. The type of hash that was performed.
+ "value": "A String", # Required. The hash value.
+ },
+ "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
+ },
"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.
- "analysisStatus": "A String", # The status of discovery for the resource.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "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 is output only and populated by the API.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
},
},
},
- "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
- "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 authority 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). # Required. Attestation for the resource.
- "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
- "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
- "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
- { # 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).
- "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
- "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
- },
- ],
- "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).
- },
- "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. # A PGP signed attestation.
- "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 hexidecimal 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", # Required. 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.
- "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).
- },
- },
- },
- "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
- "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
- "type": "A String", # Required. The type of hash that was performed.
- "value": "A String", # Required. The hash value.
- },
- "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
- "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
- },
- "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
- "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
- "location": [ # Required. 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`.
- "version": { # Version contains structured information about the version of a package. # The version installed at this location.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "cpeUri": "A String", # Required. 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.
- },
- ],
- "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.
- "createTime": "A String", # Output only. The time this occurrence was created.
},
],
}</pre>
@@ -755,115 +755,145 @@
The object takes the form of:
{ # An instance of an analysis type that has been found on a resource.
- "remediation": "A String", # A description of actions that can be taken to remedy the note.
"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
- "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
+ "longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. 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).
- "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.
- "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
},
],
- "longDescription": "A String", # Output only. A detailed description of this vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
- "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
"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.
},
- "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
- "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
"build": { # Details of a build occurrence. # Describes a verifiable build.
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. 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.
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.
- "projectId": "A String", # ID of the project.
- "id": "A String", # Required. Unique identifier of the build.
+ "logsUri": "A String", # URI where any logs for this provenance were written.
+ "startTime": "A String", # Time at which execution of the build was started.
"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.
"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",
],
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
- "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
},
],
+ "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"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",
},
- "endTime": "A String", # Time at which execution of the build was finished.
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
- "id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
- "waitFor": [ # The ID(s) of the command(s) that this command depends on.
- "A String",
- ],
- "dir": "A String", # Working directory (relative to project source root) used when running this command.
- "args": [ # Command-line arguments used when executing this command.
- "A String",
- ],
"name": "A String", # Required. 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`.
"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.
+ "args": [ # Command-line arguments used when executing this command.
+ "A String",
+ ],
+ "waitFor": [ # The ID(s) of the command(s) that this command depends on.
+ "A String",
+ ],
+ "dir": "A String", # Working directory (relative to project source root) used when running this command.
},
],
- "startTime": "A String", # Time at which execution of the build was started.
+ "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.
+ "builderVersion": "A String", # Version string of the builder at the time this build was executed.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
+ "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.
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
+ "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.
+ },
+ "revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
+ },
+ },
"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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
"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.
- "name": "A String", # The alias name.
"kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
+ "name": "A String", # The alias name.
},
"revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
},
},
],
@@ -877,69 +907,84 @@
],
},
},
- "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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
- },
- "revisionId": "A String", # A revision ID.
- },
- },
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
},
+ "projectId": "A String", # ID of the project.
"createTime": "A String", # Time at which the build was created.
- "builderVersion": "A String", # Version string of the builder at the time this build was executed.
- "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
- "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.
- "logsUri": "A String", # URI where any logs for this provenance were written.
+ "id": "A String", # Required. Unique identifier of the build.
+ "endTime": "A String", # Time at which execution of the build was finished.
},
},
- "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
- "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
- "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
+ "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.
+ "createTime": "A String", # Output only. The time this occurrence was created.
+ "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
+ "signatures": [
+ { # A signature object consists of the KeyID used and the signature itself.
+ "keyid": "A String",
+ "sig": "A String",
+ },
+ ],
+ "signed": { # This corresponds to an in-toto link.
+ "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
"A String",
],
- "userEmail": "A String", # Identity of the user that triggered this deployment.
- "platform": "A String", # Platform hosting this deployment.
- "address": "A String", # Address of the runtime element hosting this deployment.
- "undeployTime": "A String", # End of the lifetime of this deployment.
- "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
- "config": "A String", # Configuration used to create this deployment.
+ "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
+ "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
},
},
- "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+ "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
+ "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
+ "location": [ # Required. 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`.
+ "path": "A String", # The path from which we gathered that this package/version is installed.
+ "version": { # Version contains structured information about the version of a package. # The version installed at this location.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ },
+ ],
+ "name": "A String", # Output only. The name of the installed package.
+ },
+ },
"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.
+ "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
+ "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
+ "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.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. 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.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
"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.
@@ -947,111 +992,66 @@
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
},
],
- "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
- "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
},
},
- "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
- "signatures": [
- { # A signature object consists of the KeyID used and the signature itself.
- "sig": "A String",
- "keyid": "A String",
+ "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
+ "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 authority 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). # Required. Attestation for the resource.
+ "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. # A PGP signed attestation.
+ "signature": "A String", # Required. 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.
+ "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 hexidecimal 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`.
+ "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).
},
- ],
- "signed": { # This corresponds to an in-toto link.
- "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
- "customValues": {
- "a_key": "A String",
- },
+ "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
+ "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
+ "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).
+ "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
+ { # 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).
+ "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
+ "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
+ },
+ ],
},
- "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
+ },
+ },
+ "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
+ "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
+ "userEmail": "A String", # Identity of the user that triggered this deployment.
+ "address": "A String", # Address of the runtime element hosting this deployment.
+ "config": "A String", # Configuration used to create this deployment.
+ "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
- "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
- "customValues": {
- "a_key": "A String",
- },
- },
- "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
- "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
+ "platform": "A String", # Platform hosting this deployment.
+ "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
+ "undeployTime": "A String", # End of the lifetime of this deployment.
},
},
+ "remediation": "A String", # A description of actions that can be taken to remedy the note.
+ "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
+ "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
+ "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
+ "type": "A String", # Required. The type of hash that was performed.
+ "value": "A String", # Required. The hash value.
+ },
+ "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
+ },
"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.
- "analysisStatus": "A String", # The status of discovery for the resource.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "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 is output only and populated by the API.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
},
},
},
- "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
- "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 authority 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). # Required. Attestation for the resource.
- "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
- "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
- "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
- { # 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).
- "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
- "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
- },
- ],
- "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).
- },
- "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. # A PGP signed attestation.
- "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 hexidecimal 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", # Required. 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.
- "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).
- },
- },
- },
- "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
- "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
- "type": "A String", # Required. The type of hash that was performed.
- "value": "A String", # Required. The hash value.
- },
- "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
- "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
- },
- "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
- "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
- "location": [ # Required. 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`.
- "version": { # Version contains structured information about the version of a package. # The version installed at this location.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "cpeUri": "A String", # Required. 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.
- },
- ],
- "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.
- "createTime": "A String", # Output only. The time this occurrence was created.
}
x__xgafv: string, V1 error format.
@@ -1063,115 +1063,145 @@
An object of the form:
{ # An instance of an analysis type that has been found on a resource.
- "remediation": "A String", # A description of actions that can be taken to remedy the note.
"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
- "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
+ "longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. 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).
- "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.
- "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
},
],
- "longDescription": "A String", # Output only. A detailed description of this vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
- "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
"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.
},
- "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
- "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
"build": { # Details of a build occurrence. # Describes a verifiable build.
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. 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.
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.
- "projectId": "A String", # ID of the project.
- "id": "A String", # Required. Unique identifier of the build.
+ "logsUri": "A String", # URI where any logs for this provenance were written.
+ "startTime": "A String", # Time at which execution of the build was started.
"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.
"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",
],
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
- "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
},
],
+ "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"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",
},
- "endTime": "A String", # Time at which execution of the build was finished.
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
- "id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
- "waitFor": [ # The ID(s) of the command(s) that this command depends on.
- "A String",
- ],
- "dir": "A String", # Working directory (relative to project source root) used when running this command.
- "args": [ # Command-line arguments used when executing this command.
- "A String",
- ],
"name": "A String", # Required. 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`.
"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.
+ "args": [ # Command-line arguments used when executing this command.
+ "A String",
+ ],
+ "waitFor": [ # The ID(s) of the command(s) that this command depends on.
+ "A String",
+ ],
+ "dir": "A String", # Working directory (relative to project source root) used when running this command.
},
],
- "startTime": "A String", # Time at which execution of the build was started.
+ "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.
+ "builderVersion": "A String", # Version string of the builder at the time this build was executed.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
+ "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.
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
+ "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.
+ },
+ "revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
+ },
+ },
"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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
"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.
- "name": "A String", # The alias name.
"kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
+ "name": "A String", # The alias name.
},
"revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
},
},
],
@@ -1185,69 +1215,84 @@
],
},
},
- "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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
- },
- "revisionId": "A String", # A revision ID.
- },
- },
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
},
+ "projectId": "A String", # ID of the project.
"createTime": "A String", # Time at which the build was created.
- "builderVersion": "A String", # Version string of the builder at the time this build was executed.
- "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
- "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.
- "logsUri": "A String", # URI where any logs for this provenance were written.
+ "id": "A String", # Required. Unique identifier of the build.
+ "endTime": "A String", # Time at which execution of the build was finished.
},
},
- "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
- "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
- "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
+ "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.
+ "createTime": "A String", # Output only. The time this occurrence was created.
+ "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
+ "signatures": [
+ { # A signature object consists of the KeyID used and the signature itself.
+ "keyid": "A String",
+ "sig": "A String",
+ },
+ ],
+ "signed": { # This corresponds to an in-toto link.
+ "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
"A String",
],
- "userEmail": "A String", # Identity of the user that triggered this deployment.
- "platform": "A String", # Platform hosting this deployment.
- "address": "A String", # Address of the runtime element hosting this deployment.
- "undeployTime": "A String", # End of the lifetime of this deployment.
- "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
- "config": "A String", # Configuration used to create this deployment.
+ "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
+ "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
},
},
- "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+ "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
+ "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
+ "location": [ # Required. 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`.
+ "path": "A String", # The path from which we gathered that this package/version is installed.
+ "version": { # Version contains structured information about the version of a package. # The version installed at this location.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ },
+ ],
+ "name": "A String", # Output only. The name of the installed package.
+ },
+ },
"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.
+ "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
+ "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
+ "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.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. 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.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
"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.
@@ -1255,111 +1300,66 @@
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
},
],
- "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
- "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
},
},
- "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
- "signatures": [
- { # A signature object consists of the KeyID used and the signature itself.
- "sig": "A String",
- "keyid": "A String",
+ "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
+ "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 authority 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). # Required. Attestation for the resource.
+ "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. # A PGP signed attestation.
+ "signature": "A String", # Required. 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.
+ "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 hexidecimal 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`.
+ "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).
},
- ],
- "signed": { # This corresponds to an in-toto link.
- "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
- "customValues": {
- "a_key": "A String",
- },
+ "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
+ "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
+ "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).
+ "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
+ { # 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).
+ "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
+ "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
+ },
+ ],
},
- "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
+ },
+ },
+ "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
+ "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
+ "userEmail": "A String", # Identity of the user that triggered this deployment.
+ "address": "A String", # Address of the runtime element hosting this deployment.
+ "config": "A String", # Configuration used to create this deployment.
+ "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
- "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
- "customValues": {
- "a_key": "A String",
- },
- },
- "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
- "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
+ "platform": "A String", # Platform hosting this deployment.
+ "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
+ "undeployTime": "A String", # End of the lifetime of this deployment.
},
},
+ "remediation": "A String", # A description of actions that can be taken to remedy the note.
+ "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
+ "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
+ "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
+ "type": "A String", # Required. The type of hash that was performed.
+ "value": "A String", # Required. The hash value.
+ },
+ "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
+ },
"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.
- "analysisStatus": "A String", # The status of discovery for the resource.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "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 is output only and populated by the API.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
},
},
},
- "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
- "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 authority 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). # Required. Attestation for the resource.
- "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
- "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
- "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
- { # 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).
- "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
- "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
- },
- ],
- "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).
- },
- "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. # A PGP signed attestation.
- "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 hexidecimal 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", # Required. 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.
- "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).
- },
- },
- },
- "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
- "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
- "type": "A String", # Required. The type of hash that was performed.
- "value": "A String", # Required. The hash value.
- },
- "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
- "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
- },
- "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
- "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
- "location": [ # Required. 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`.
- "version": { # Version contains structured information about the version of a package. # The version installed at this location.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "cpeUri": "A String", # Required. 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.
- },
- ],
- "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.
- "createTime": "A String", # Output only. The time this occurrence was created.
}</pre>
</div>
@@ -1396,115 +1396,145 @@
An object of the form:
{ # An instance of an analysis type that has been found on a resource.
- "remediation": "A String", # A description of actions that can be taken to remedy the note.
"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
- "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
+ "longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. 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).
- "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.
- "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
},
],
- "longDescription": "A String", # Output only. A detailed description of this vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
- "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
"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.
},
- "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
- "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
"build": { # Details of a build occurrence. # Describes a verifiable build.
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. 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.
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.
- "projectId": "A String", # ID of the project.
- "id": "A String", # Required. Unique identifier of the build.
+ "logsUri": "A String", # URI where any logs for this provenance were written.
+ "startTime": "A String", # Time at which execution of the build was started.
"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.
"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",
],
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
- "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
},
],
+ "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"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",
},
- "endTime": "A String", # Time at which execution of the build was finished.
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
- "id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
- "waitFor": [ # The ID(s) of the command(s) that this command depends on.
- "A String",
- ],
- "dir": "A String", # Working directory (relative to project source root) used when running this command.
- "args": [ # Command-line arguments used when executing this command.
- "A String",
- ],
"name": "A String", # Required. 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`.
"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.
+ "args": [ # Command-line arguments used when executing this command.
+ "A String",
+ ],
+ "waitFor": [ # The ID(s) of the command(s) that this command depends on.
+ "A String",
+ ],
+ "dir": "A String", # Working directory (relative to project source root) used when running this command.
},
],
- "startTime": "A String", # Time at which execution of the build was started.
+ "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.
+ "builderVersion": "A String", # Version string of the builder at the time this build was executed.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
+ "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.
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
+ "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.
+ },
+ "revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
+ },
+ },
"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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
"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.
- "name": "A String", # The alias name.
"kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
+ "name": "A String", # The alias name.
},
"revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
},
},
],
@@ -1518,69 +1548,84 @@
],
},
},
- "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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
- },
- "revisionId": "A String", # A revision ID.
- },
- },
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
},
+ "projectId": "A String", # ID of the project.
"createTime": "A String", # Time at which the build was created.
- "builderVersion": "A String", # Version string of the builder at the time this build was executed.
- "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
- "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.
- "logsUri": "A String", # URI where any logs for this provenance were written.
+ "id": "A String", # Required. Unique identifier of the build.
+ "endTime": "A String", # Time at which execution of the build was finished.
},
},
- "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
- "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
- "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
+ "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.
+ "createTime": "A String", # Output only. The time this occurrence was created.
+ "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
+ "signatures": [
+ { # A signature object consists of the KeyID used and the signature itself.
+ "keyid": "A String",
+ "sig": "A String",
+ },
+ ],
+ "signed": { # This corresponds to an in-toto link.
+ "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
"A String",
],
- "userEmail": "A String", # Identity of the user that triggered this deployment.
- "platform": "A String", # Platform hosting this deployment.
- "address": "A String", # Address of the runtime element hosting this deployment.
- "undeployTime": "A String", # End of the lifetime of this deployment.
- "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
- "config": "A String", # Configuration used to create this deployment.
+ "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
+ "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
},
},
- "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+ "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
+ "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
+ "location": [ # Required. 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`.
+ "path": "A String", # The path from which we gathered that this package/version is installed.
+ "version": { # Version contains structured information about the version of a package. # The version installed at this location.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ },
+ ],
+ "name": "A String", # Output only. The name of the installed package.
+ },
+ },
"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.
+ "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
+ "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
+ "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.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. 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.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
"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.
@@ -1588,111 +1633,66 @@
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
},
],
- "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
- "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
},
},
- "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
- "signatures": [
- { # A signature object consists of the KeyID used and the signature itself.
- "sig": "A String",
- "keyid": "A String",
+ "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
+ "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 authority 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). # Required. Attestation for the resource.
+ "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. # A PGP signed attestation.
+ "signature": "A String", # Required. 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.
+ "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 hexidecimal 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`.
+ "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).
},
- ],
- "signed": { # This corresponds to an in-toto link.
- "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
- "customValues": {
- "a_key": "A String",
- },
+ "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
+ "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
+ "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).
+ "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
+ { # 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).
+ "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
+ "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
+ },
+ ],
},
- "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
+ },
+ },
+ "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
+ "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
+ "userEmail": "A String", # Identity of the user that triggered this deployment.
+ "address": "A String", # Address of the runtime element hosting this deployment.
+ "config": "A String", # Configuration used to create this deployment.
+ "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
- "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
- "customValues": {
- "a_key": "A String",
- },
- },
- "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
- "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
+ "platform": "A String", # Platform hosting this deployment.
+ "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
+ "undeployTime": "A String", # End of the lifetime of this deployment.
},
},
+ "remediation": "A String", # A description of actions that can be taken to remedy the note.
+ "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
+ "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
+ "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
+ "type": "A String", # Required. The type of hash that was performed.
+ "value": "A String", # Required. The hash value.
+ },
+ "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
+ },
"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.
- "analysisStatus": "A String", # The status of discovery for the resource.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "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 is output only and populated by the API.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
},
},
},
- "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
- "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 authority 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). # Required. Attestation for the resource.
- "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
- "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
- "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
- { # 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).
- "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
- "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
- },
- ],
- "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).
- },
- "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. # A PGP signed attestation.
- "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 hexidecimal 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", # Required. 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.
- "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).
- },
- },
- },
- "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
- "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
- "type": "A String", # Required. The type of hash that was performed.
- "value": "A String", # Required. The hash value.
- },
- "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
- "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
- },
- "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
- "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
- "location": [ # Required. 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`.
- "version": { # Version contains structured information about the version of a package. # The version installed at this location.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "cpeUri": "A String", # Required. 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.
- },
- ],
- "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.
- "createTime": "A String", # Output only. The time this occurrence was created.
}</pre>
</div>
@@ -1721,22 +1721,21 @@
{ # 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` to a single `role`. Members 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](https://cloud.google.com/iam/help/conditions/resource-policies). **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](https://cloud.google.com/iam/docs/).
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
- "A String",
- ],
- "bindingId": "A String",
"condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
},
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
}</pre>
</div>
@@ -1755,166 +1754,166 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "relatedNoteNames": [ # Other notes related to this note.
+ "attestationAuthority": { # 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. # A note describing an attestation role.
+ "hint": { # 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. # Hint hints at the purpose of the attestation authority.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ },
+ },
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "label": "A String", # Label to describe usage of the URL.
- "url": "A String", # Specific URL associated with the resource.
+ },
+ "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
+ "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
+ "scope": "A String",
+ "confidentialityImpact": "A String",
+ "privilegesRequired": "A String",
+ "integrityImpact": "A String",
+ "impactScore": 3.14,
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "exploitabilityScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
+ },
+ "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
+ {
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
+ "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
+ },
+ ],
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
},
],
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
+ { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "package": "A String", # Required. The package being described.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
+ },
+ "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # Required. The name of the package where the vulnerability was found.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
},
+ ],
+ "cvssScore": 3.14, # The CVSS score for this vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
+ },
+ "relatedNoteNames": [ # Other notes related to this note.
+ "A String",
+ ],
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "label": "A String", # Label to describe usage of the URL.
+ "url": "A String", # Specific URL associated with the resource.
},
- "longDescription": "A String", # A detailed description of this note.
- "attestationAuthority": { # 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. # A note describing an attestation role.
- "hint": { # 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. # Hint hints at the purpose of the attestation authority.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ ],
+ "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
},
- },
- "baseImage": { # 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. # A note describing a base image.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
"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.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
- },
- "discovery": { # 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. # A note describing the initial analysis of a resource.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
- },
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
- {
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
- {
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
- "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
- },
- ],
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "description": "A String", # The description of the vulnerability.
- "name": "A String", # Required. The name of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
- "userInteraction": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "availabilityImpact": "A String",
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "confidentialityImpact": "A String",
- "privilegesRequired": "A String",
- "scope": "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
},
- "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "description": "A String", # A vendor-specific description of this note.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
- "package": "A String", # Required. The name of the package where the vulnerability was found.
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
- "package": "A String", # Required. The package being described.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- },
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
+ "longDescription": "A String", # A detailed description of this note.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
+ "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
+ "description": "A String", # The distribution channel-specific description of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
},
- ],
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- },
- "shortDescription": "A String", # A one sentence description of this note.
- "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
- "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- },
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
+ },
+ ],
+ "name": "A String", # Required. Immutable. The name of the package.
+ },
+ "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
+ "discovery": { # 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. # A note describing the initial analysis of a resource.
+ "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
+ },
+ "baseImage": { # 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. # A note describing a base image.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
+ "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.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
},
- "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
- "description": "A String", # The distribution channel-specific description of this package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
- },
- ],
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
+ },
+ "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
},
- "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- }</pre>
+ },
+ }</pre>
</div>
<div class="method">
@@ -1935,15 +1934,15 @@
{ # A summary of how many vulnerability occurrences there are per resource and severity type.
"counts": [ # A listing by resource of the number of fixable and total vulnerabilities.
{ # Per resource and severity counts of fixable and total vulnerabilities.
+ "totalCount": "A String", # The total number of vulnerabilities associated with this resource.
"severity": "A String", # The severity for this count. SEVERITY_UNSPECIFIED indicates total across all severities.
"fixableCount": "A String", # The number of fixable vulnerabilities associated with this resource.
- "totalCount": "A String", # The total number of vulnerabilities associated with this resource.
"resource": { # An entity that can have metadata. For example, a Docker image. # The affected resource.
+ "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
"type": "A String", # Required. The type of hash that was performed.
"value": "A String", # Required. The hash value.
},
- "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
},
},
@@ -1952,14 +1951,14 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists occurrences for the specified project.
Args:
parent: string, Required. The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`. (required)
+ filter: string, The filter expression.
pageToken: string, Token to provide to skip to a particular spot in the list.
pageSize: integer, Number of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
- filter: string, The filter expression.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1972,115 +1971,145 @@
"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.
"occurrences": [ # The occurrences requested.
{ # An instance of an analysis type that has been found on a resource.
- "remediation": "A String", # A description of actions that can be taken to remedy the note.
"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
- "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
+ "longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. 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).
- "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.
- "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
},
],
- "longDescription": "A String", # Output only. A detailed description of this vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
- "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
"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.
},
- "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
- "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
"build": { # Details of a build occurrence. # Describes a verifiable build.
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. 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.
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.
- "projectId": "A String", # ID of the project.
- "id": "A String", # Required. Unique identifier of the build.
+ "logsUri": "A String", # URI where any logs for this provenance were written.
+ "startTime": "A String", # Time at which execution of the build was started.
"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.
"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",
],
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
- "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
},
],
+ "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"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",
},
- "endTime": "A String", # Time at which execution of the build was finished.
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
- "id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
- "waitFor": [ # The ID(s) of the command(s) that this command depends on.
- "A String",
- ],
- "dir": "A String", # Working directory (relative to project source root) used when running this command.
- "args": [ # Command-line arguments used when executing this command.
- "A String",
- ],
"name": "A String", # Required. 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`.
"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.
+ "args": [ # Command-line arguments used when executing this command.
+ "A String",
+ ],
+ "waitFor": [ # The ID(s) of the command(s) that this command depends on.
+ "A String",
+ ],
+ "dir": "A String", # Working directory (relative to project source root) used when running this command.
},
],
- "startTime": "A String", # Time at which execution of the build was started.
+ "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.
+ "builderVersion": "A String", # Version string of the builder at the time this build was executed.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
+ "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.
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
+ "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.
+ },
+ "revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
+ },
+ },
"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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
"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.
- "name": "A String", # The alias name.
"kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
+ "name": "A String", # The alias name.
},
"revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
},
},
],
@@ -2094,69 +2123,84 @@
],
},
},
- "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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
- },
- "revisionId": "A String", # A revision ID.
- },
- },
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
},
+ "projectId": "A String", # ID of the project.
"createTime": "A String", # Time at which the build was created.
- "builderVersion": "A String", # Version string of the builder at the time this build was executed.
- "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
- "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.
- "logsUri": "A String", # URI where any logs for this provenance were written.
+ "id": "A String", # Required. Unique identifier of the build.
+ "endTime": "A String", # Time at which execution of the build was finished.
},
},
- "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
- "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
- "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
+ "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.
+ "createTime": "A String", # Output only. The time this occurrence was created.
+ "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
+ "signatures": [
+ { # A signature object consists of the KeyID used and the signature itself.
+ "keyid": "A String",
+ "sig": "A String",
+ },
+ ],
+ "signed": { # This corresponds to an in-toto link.
+ "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
"A String",
],
- "userEmail": "A String", # Identity of the user that triggered this deployment.
- "platform": "A String", # Platform hosting this deployment.
- "address": "A String", # Address of the runtime element hosting this deployment.
- "undeployTime": "A String", # End of the lifetime of this deployment.
- "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
- "config": "A String", # Configuration used to create this deployment.
+ "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
+ "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
},
},
- "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+ "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
+ "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
+ "location": [ # Required. 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`.
+ "path": "A String", # The path from which we gathered that this package/version is installed.
+ "version": { # Version contains structured information about the version of a package. # The version installed at this location.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ },
+ ],
+ "name": "A String", # Output only. The name of the installed package.
+ },
+ },
"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.
+ "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
+ "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
+ "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.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. 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.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
"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.
@@ -2164,111 +2208,66 @@
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
},
],
- "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
- "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
},
},
- "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
- "signatures": [
- { # A signature object consists of the KeyID used and the signature itself.
- "sig": "A String",
- "keyid": "A String",
+ "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
+ "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 authority 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). # Required. Attestation for the resource.
+ "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. # A PGP signed attestation.
+ "signature": "A String", # Required. 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.
+ "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 hexidecimal 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`.
+ "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).
},
- ],
- "signed": { # This corresponds to an in-toto link.
- "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
- "customValues": {
- "a_key": "A String",
- },
+ "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
+ "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
+ "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).
+ "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
+ { # 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).
+ "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
+ "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
+ },
+ ],
},
- "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
+ },
+ },
+ "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
+ "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
+ "userEmail": "A String", # Identity of the user that triggered this deployment.
+ "address": "A String", # Address of the runtime element hosting this deployment.
+ "config": "A String", # Configuration used to create this deployment.
+ "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
- "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
- "customValues": {
- "a_key": "A String",
- },
- },
- "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
- "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
+ "platform": "A String", # Platform hosting this deployment.
+ "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
+ "undeployTime": "A String", # End of the lifetime of this deployment.
},
},
+ "remediation": "A String", # A description of actions that can be taken to remedy the note.
+ "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
+ "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
+ "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
+ "type": "A String", # Required. The type of hash that was performed.
+ "value": "A String", # Required. The hash value.
+ },
+ "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
+ },
"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.
- "analysisStatus": "A String", # The status of discovery for the resource.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "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 is output only and populated by the API.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
},
},
},
- "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
- "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 authority 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). # Required. Attestation for the resource.
- "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
- "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
- "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
- { # 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).
- "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
- "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
- },
- ],
- "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).
- },
- "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. # A PGP signed attestation.
- "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 hexidecimal 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", # Required. 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.
- "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).
- },
- },
- },
- "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
- "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
- "type": "A String", # Required. The type of hash that was performed.
- "value": "A String", # Required. The hash value.
- },
- "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
- "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
- },
- "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
- "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
- "location": [ # Required. 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`.
- "version": { # Version contains structured information about the version of a package. # The version installed at this location.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "cpeUri": "A String", # Required. 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.
- },
- ],
- "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.
- "createTime": "A String", # Output only. The time this occurrence was created.
},
],
}</pre>
@@ -2298,115 +2297,145 @@
The object takes the form of:
{ # An instance of an analysis type that has been found on a resource.
- "remediation": "A String", # A description of actions that can be taken to remedy the note.
"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
- "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
+ "longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. 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).
- "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.
- "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
},
],
- "longDescription": "A String", # Output only. A detailed description of this vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
- "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
"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.
},
- "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
- "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
"build": { # Details of a build occurrence. # Describes a verifiable build.
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. 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.
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.
- "projectId": "A String", # ID of the project.
- "id": "A String", # Required. Unique identifier of the build.
+ "logsUri": "A String", # URI where any logs for this provenance were written.
+ "startTime": "A String", # Time at which execution of the build was started.
"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.
"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",
],
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
- "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
},
],
+ "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"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",
},
- "endTime": "A String", # Time at which execution of the build was finished.
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
- "id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
- "waitFor": [ # The ID(s) of the command(s) that this command depends on.
- "A String",
- ],
- "dir": "A String", # Working directory (relative to project source root) used when running this command.
- "args": [ # Command-line arguments used when executing this command.
- "A String",
- ],
"name": "A String", # Required. 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`.
"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.
+ "args": [ # Command-line arguments used when executing this command.
+ "A String",
+ ],
+ "waitFor": [ # The ID(s) of the command(s) that this command depends on.
+ "A String",
+ ],
+ "dir": "A String", # Working directory (relative to project source root) used when running this command.
},
],
- "startTime": "A String", # Time at which execution of the build was started.
+ "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.
+ "builderVersion": "A String", # Version string of the builder at the time this build was executed.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
+ "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.
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
+ "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.
+ },
+ "revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
+ },
+ },
"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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
"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.
- "name": "A String", # The alias name.
"kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
+ "name": "A String", # The alias name.
},
"revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
},
},
],
@@ -2420,69 +2449,84 @@
],
},
},
- "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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
- },
- "revisionId": "A String", # A revision ID.
- },
- },
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
},
+ "projectId": "A String", # ID of the project.
"createTime": "A String", # Time at which the build was created.
- "builderVersion": "A String", # Version string of the builder at the time this build was executed.
- "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
- "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.
- "logsUri": "A String", # URI where any logs for this provenance were written.
+ "id": "A String", # Required. Unique identifier of the build.
+ "endTime": "A String", # Time at which execution of the build was finished.
},
},
- "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
- "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
- "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
+ "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.
+ "createTime": "A String", # Output only. The time this occurrence was created.
+ "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
+ "signatures": [
+ { # A signature object consists of the KeyID used and the signature itself.
+ "keyid": "A String",
+ "sig": "A String",
+ },
+ ],
+ "signed": { # This corresponds to an in-toto link.
+ "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
"A String",
],
- "userEmail": "A String", # Identity of the user that triggered this deployment.
- "platform": "A String", # Platform hosting this deployment.
- "address": "A String", # Address of the runtime element hosting this deployment.
- "undeployTime": "A String", # End of the lifetime of this deployment.
- "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
- "config": "A String", # Configuration used to create this deployment.
+ "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
+ "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
},
},
- "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+ "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
+ "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
+ "location": [ # Required. 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`.
+ "path": "A String", # The path from which we gathered that this package/version is installed.
+ "version": { # Version contains structured information about the version of a package. # The version installed at this location.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ },
+ ],
+ "name": "A String", # Output only. The name of the installed package.
+ },
+ },
"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.
+ "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
+ "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
+ "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.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. 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.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
"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.
@@ -2490,111 +2534,66 @@
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
},
],
- "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
- "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
},
},
- "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
- "signatures": [
- { # A signature object consists of the KeyID used and the signature itself.
- "sig": "A String",
- "keyid": "A String",
+ "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
+ "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 authority 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). # Required. Attestation for the resource.
+ "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. # A PGP signed attestation.
+ "signature": "A String", # Required. 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.
+ "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 hexidecimal 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`.
+ "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).
},
- ],
- "signed": { # This corresponds to an in-toto link.
- "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
- "customValues": {
- "a_key": "A String",
- },
+ "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
+ "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
+ "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).
+ "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
+ { # 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).
+ "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
+ "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
+ },
+ ],
},
- "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
+ },
+ },
+ "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
+ "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
+ "userEmail": "A String", # Identity of the user that triggered this deployment.
+ "address": "A String", # Address of the runtime element hosting this deployment.
+ "config": "A String", # Configuration used to create this deployment.
+ "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
- "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
- "customValues": {
- "a_key": "A String",
- },
- },
- "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
- "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
+ "platform": "A String", # Platform hosting this deployment.
+ "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
+ "undeployTime": "A String", # End of the lifetime of this deployment.
},
},
+ "remediation": "A String", # A description of actions that can be taken to remedy the note.
+ "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
+ "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
+ "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
+ "type": "A String", # Required. The type of hash that was performed.
+ "value": "A String", # Required. The hash value.
+ },
+ "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
+ },
"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.
- "analysisStatus": "A String", # The status of discovery for the resource.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "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 is output only and populated by the API.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
},
},
},
- "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
- "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 authority 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). # Required. Attestation for the resource.
- "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
- "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
- "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
- { # 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).
- "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
- "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
- },
- ],
- "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).
- },
- "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. # A PGP signed attestation.
- "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 hexidecimal 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", # Required. 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.
- "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).
- },
- },
- },
- "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
- "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
- "type": "A String", # Required. The type of hash that was performed.
- "value": "A String", # Required. The hash value.
- },
- "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
- "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
- },
- "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
- "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
- "location": [ # Required. 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`.
- "version": { # Version contains structured information about the version of a package. # The version installed at this location.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "cpeUri": "A String", # Required. 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.
- },
- ],
- "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.
- "createTime": "A String", # Output only. The time this occurrence was created.
}
updateMask: string, The fields to update.
@@ -2607,115 +2606,145 @@
An object of the form:
{ # An instance of an analysis type that has been found on a resource.
- "remediation": "A String", # A description of actions that can be taken to remedy the note.
"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
- "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
+ "longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. 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).
- "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.
- "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
+ "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
"package": "A String", # Required. The package being described.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
},
},
],
- "longDescription": "A String", # Output only. A detailed description of this vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
- "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.
"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.
},
- "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
- "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
"build": { # Details of a build occurrence. # Describes a verifiable build.
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. 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.
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.
- "projectId": "A String", # ID of the project.
- "id": "A String", # Required. Unique identifier of the build.
+ "logsUri": "A String", # URI where any logs for this provenance were written.
+ "startTime": "A String", # Time at which execution of the build was started.
"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.
"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",
],
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
- "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
},
],
+ "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"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",
},
- "endTime": "A String", # Time at which execution of the build was finished.
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
- "id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
- "waitFor": [ # The ID(s) of the command(s) that this command depends on.
- "A String",
- ],
- "dir": "A String", # Working directory (relative to project source root) used when running this command.
- "args": [ # Command-line arguments used when executing this command.
- "A String",
- ],
"name": "A String", # Required. 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`.
"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.
+ "args": [ # Command-line arguments used when executing this command.
+ "A String",
+ ],
+ "waitFor": [ # The ID(s) of the command(s) that this command depends on.
+ "A String",
+ ],
+ "dir": "A String", # Working directory (relative to project source root) used when running this command.
},
],
- "startTime": "A String", # Time at which execution of the build was started.
+ "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.
+ "builderVersion": "A String", # Version string of the builder at the time this build was executed.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
+ "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.
+ "labels": { # Labels with user defined metadata.
+ "a_key": "A String",
+ },
+ "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.
+ },
+ "revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
+ },
+ },
"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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
"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.
- "name": "A String", # The alias name.
"kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
+ "name": "A String", # The alias name.
},
"revisionId": "A String", # A revision ID.
+ "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.
+ "repoName": "A String", # The name of the repo. Leave empty for the default repo.
+ "projectId": "A String", # The ID of the project.
+ },
+ "uid": "A String", # A server-assigned, globally unique identifier.
+ },
+ },
+ "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).
+ "url": "A String", # Git repository URL.
+ "revisionId": "A String", # Git commit hash.
+ },
+ "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
+ "revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "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.
},
},
],
@@ -2729,69 +2758,84 @@
],
},
},
- "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.
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "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.
- "revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- },
- "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).
- "url": "A String", # Git repository URL.
- "revisionId": "A String", # Git commit hash.
- },
- "labels": { # Labels with user defined metadata.
- "a_key": "A String",
- },
- "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.
- "name": "A String", # The alias name.
- "kind": "A String", # The alias kind.
- },
- "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
- "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.
- },
- },
- "revisionId": "A String", # A revision ID.
- },
- },
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
},
+ "projectId": "A String", # ID of the project.
"createTime": "A String", # Time at which the build was created.
- "builderVersion": "A String", # Version string of the builder at the time this build was executed.
- "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
- "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.
- "logsUri": "A String", # URI where any logs for this provenance were written.
+ "id": "A String", # Required. Unique identifier of the build.
+ "endTime": "A String", # Time at which execution of the build was finished.
},
},
- "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
- "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
- "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
+ "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.
+ "createTime": "A String", # Output only. The time this occurrence was created.
+ "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
+ "signatures": [
+ { # A signature object consists of the KeyID used and the signature itself.
+ "keyid": "A String",
+ "sig": "A String",
+ },
+ ],
+ "signed": { # This corresponds to an in-toto link.
+ "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
"A String",
],
- "userEmail": "A String", # Identity of the user that triggered this deployment.
- "platform": "A String", # Platform hosting this deployment.
- "address": "A String", # Address of the runtime element hosting this deployment.
- "undeployTime": "A String", # End of the lifetime of this deployment.
- "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
- "config": "A String", # Configuration used to create this deployment.
+ "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
+ "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
+ "customValues": {
+ "a_key": "A String",
+ },
+ },
+ "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
+ {
+ "resourceUri": "A String",
+ "hashes": { # Defines a hash object for use in Materials and Products.
+ "sha256": "A String",
+ },
+ },
+ ],
},
},
- "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+ "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
+ "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
+ "location": [ # Required. 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`.
+ "path": "A String", # The path from which we gathered that this package/version is installed.
+ "version": { # Version contains structured information about the version of a package. # The version installed at this location.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ },
+ ],
+ "name": "A String", # Output only. The name of the installed package.
+ },
+ },
"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.
+ "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
+ "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
+ "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.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. 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.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
"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.
@@ -2799,111 +2843,66 @@
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
},
],
- "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
- "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
},
},
- "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
- "signatures": [
- { # A signature object consists of the KeyID used and the signature itself.
- "sig": "A String",
- "keyid": "A String",
+ "updateTime": "A String", # Output only. The time this occurrence was last updated.
+ "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
+ "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 authority 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). # Required. Attestation for the resource.
+ "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. # A PGP signed attestation.
+ "signature": "A String", # Required. 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.
+ "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 hexidecimal 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`.
+ "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).
},
- ],
- "signed": { # This corresponds to an in-toto link.
- "byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
- "customValues": {
- "a_key": "A String",
- },
+ "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
+ "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
+ "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).
+ "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
+ { # 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).
+ "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
+ "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
+ },
+ ],
},
- "command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
+ },
+ },
+ "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
+ "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
+ "userEmail": "A String", # Identity of the user that triggered this deployment.
+ "address": "A String", # Address of the runtime element hosting this deployment.
+ "config": "A String", # Configuration used to create this deployment.
+ "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
- "environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
- "customValues": {
- "a_key": "A String",
- },
- },
- "products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
- "materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
- {
- "hashes": { # Defines a hash object for use in Materials and Products.
- "sha256": "A String",
- },
- "resourceUri": "A String",
- },
- ],
+ "platform": "A String", # Platform hosting this deployment.
+ "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
+ "undeployTime": "A String", # End of the lifetime of this deployment.
},
},
+ "remediation": "A String", # A description of actions that can be taken to remedy the note.
+ "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
+ "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
+ "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
+ "type": "A String", # Required. The type of hash that was performed.
+ "value": "A String", # Required. The hash value.
+ },
+ "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
+ },
"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.
- "analysisStatus": "A String", # The status of discovery for the resource.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "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 is output only and populated by the API.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "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.
},
},
},
- "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
- "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 authority 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). # Required. Attestation for the resource.
- "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
- "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
- "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
- { # 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).
- "signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
- "publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
- },
- ],
- "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).
- },
- "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. # A PGP signed attestation.
- "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 hexidecimal 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", # Required. 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.
- "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).
- },
- },
- },
- "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
- "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
- "type": "A String", # Required. The type of hash that was performed.
- "value": "A String", # Required. The hash value.
- },
- "name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
- "uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
- },
- "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
- "installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
- "location": [ # Required. 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`.
- "version": { # Version contains structured information about the version of a package. # The version installed at this location.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "cpeUri": "A String", # Required. 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.
- },
- ],
- "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.
- "createTime": "A String", # Output only. The time this occurrence was created.
}</pre>
</div>
@@ -2919,22 +2918,21 @@
{ # Request message for `SetIamPolicy` method.
"policy": { # 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` to a single `role`. Members 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](https://cloud.google.com/iam/help/conditions/resource-policies). **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](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
- "A String",
- ],
- "bindingId": "A String",
"condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
},
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
},
}
@@ -2948,22 +2946,21 @@
{ # 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` to a single `role`. Members 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](https://cloud.google.com/iam/help/conditions/resource-policies). **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](https://cloud.google.com/iam/docs/).
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
- "A String",
- ],
- "bindingId": "A String",
"condition": { # 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
},
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
}</pre>
</div>