docs: update generated docs (#981)
diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
index 9e99c58..4f3b956 100644
--- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
@@ -80,7 +80,7 @@
<p class="firstline">Returns the occurrences Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body=None, name=None, noteId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, noteId=None, name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new `Note`.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -92,7 +92,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a note or an `Occurrence` resource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, filter=None, name=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageSize=None, name=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all `Notes` for a given project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -108,7 +108,7 @@
<p class="firstline">Returns the permissions that a caller has on the specified note or</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body=None, name=None, noteId=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, noteId=None, name=None, x__xgafv=None)</code>
<pre>Creates a new `Note`.
Args:
@@ -118,242 +118,41 @@
The object takes the form of:
{ # Provides a detailed description of a `Note`.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- },
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
- # the provenance message in linked BuildDetails.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
- # `BuilderDetails`.
- "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).
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
- },
- "builderVersion": "A String", # Version of the builder which produced this Note.
- },
- "longDescription": "A String", # A detailed description of this `Note`.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` 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.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. 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 AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "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 occurrences 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 the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ # various channels.
+ # e.g. glibc (aka libc6) is distributed by many, at various versions.
+ "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
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
"name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "package": "A String", # The package being described.
+ "maintainer": "A String", # A freeform string denoting the maintainer of 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.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
},
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cpeUri": "A String", # 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.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- },
- ],
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- },
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
+ ],
+ "name": "A String", # The name of the package.
},
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- "severity": "A String", # The severity as specified by the upstream operating system.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
- "A String",
- ],
- },
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
- # various channels.
- # e.g. glibc (aka libc6) is distributed by many, at various versions.
- "name": "A String", # 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
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
- # this distribution channel.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "description": "A String", # The distribution channel-specific description of this package.
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a 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
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- },
- ],
- },
- "createTime": "A String", # Output only. The time this note was created. 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 # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
- # indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
- },
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
-}
-
- name: string, The name of the project.
-Should be of the form "providers/{provider_id}".
-@Deprecated
- noteId: string, The ID to use for this note.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Provides a detailed description of a `Note`.
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
"relatedUrl": [ # URLs associated with this note
{ # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
"label": "A String", # Label to describe usage of the URL
+ "url": "A String", # Specific URL to associate with the note
},
],
"expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
@@ -362,27 +161,98 @@
# equivalent image via:
# FROM <Basis.resource_url>
# Or an equivalent reference, e.g. a tag of the resource_url.
+ "resourceUrl": "A String", # 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. # 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.
+ # This field can be used as a filter in list requests.
"v2Blob": [ # The ordered list of v2 blobs that represent a given image.
"A String",
],
"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
# representation.
# This field can be used as a filter in list requests.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
},
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
},
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ # filter in list requests.
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "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 occurrences 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
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "package": "A String", # The package being described.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "cpeUri": "A String", # 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.
+ # This field can be used as a filter in list requests.
+ },
+ ],
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ },
"buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
# the provenance message in linked BuildDetails.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
# `BuilderDetails`.
+ "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", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
"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.
@@ -396,23 +266,27 @@
# 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).
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
},
"builderVersion": "A String", # Version of the builder which produced this Note.
},
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
"longDescription": "A String", # A detailed description of this `Note`.
"deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
"resourceUri": [ # Resource URI for the artifact being deployed.
"A String",
],
},
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
"shortDescription": "A String", # A one sentence description of this `Note`.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
+ # indicate the status of the analysis. Absence of an occurrence linked to this
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ },
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
# example, an organization might have one `AttestationAuthority` for "QA" and
# one for "build". This Note is intended to act strictly as a grouping
@@ -431,85 +305,20 @@
"humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
},
},
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "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 occurrences 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 the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "package": "A String", # The package being described.
- },
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cpeUri": "A String", # 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.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- },
- ],
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- },
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
# version. For each package version combination (i.e. bash 4.0, bash 4.1,
# bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
"version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
"name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each
@@ -517,57 +326,248 @@
# updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the
# upstream operating system upgrade feed.
- "severity": "A String", # The severity as specified by the upstream operating system.
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
# https://cpe.mitre.org/specification/.
+ "severity": "A String", # The severity as specified by the upstream operating system.
"cve": [ # The cve that would be resolved by this upgrade.
"A String",
],
},
],
- "package": "A String", # Required - The package this Upgrade is for.
},
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
- # various channels.
- # e.g. glibc (aka libc6) is distributed by many, at various versions.
- "name": "A String", # 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
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
- # this distribution channel.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
+ }
+
+ noteId: string, The ID to use for this note.
+ name: string, The name of the project.
+Should be of the form "providers/{provider_id}".
+@Deprecated
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Provides a detailed description of a `Note`.
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ # various channels.
+ # e.g. glibc (aka libc6) is distributed by many, at various versions.
+ "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
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # this distribution channel.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "maintainer": "A String", # A freeform string denoting the maintainer of 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.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
},
- "description": "A String", # The distribution channel-specific description of this package.
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a 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
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ ],
+ "name": "A String", # The name of the package.
+ },
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "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 to associate with the note
},
],
- },
- "createTime": "A String", # Output only. The time this note was created. 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 # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
- # indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
- },
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- }</pre>
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "resourceUrl": "A String", # 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. # 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.
+ # This field can be used as a filter in list requests.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
+ },
+ },
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ # filter in list requests.
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "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 occurrences 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
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "package": "A String", # The package being described.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "cpeUri": "A String", # 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.
+ # This field can be used as a filter in list requests.
+ },
+ ],
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ # the provenance message in linked BuildDetails.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ # `BuilderDetails`.
+ "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", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "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`
+ },
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
+ # indicate the status of the analysis. Absence of an occurrence linked to this
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ },
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` 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.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. 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 AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
+ },
+ },
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ },
+ ],
+ },
+ }</pre>
</div>
<div class="method">
@@ -613,224 +613,224 @@
An object of the form:
{ # Provides a detailed description of a `Note`.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- },
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
- # the provenance message in linked BuildDetails.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
- # `BuilderDetails`.
- "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).
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
- },
- "builderVersion": "A String", # Version of the builder which produced this Note.
- },
- "longDescription": "A String", # A detailed description of this `Note`.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` 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.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. 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 AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "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 occurrences 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 the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ # various channels.
+ # e.g. glibc (aka libc6) is distributed by many, at various versions.
+ "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
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
"name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "package": "A String", # The package being described.
+ "maintainer": "A String", # A freeform string denoting the maintainer of 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.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
},
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cpeUri": "A String", # 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.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
+ ],
+ "name": "A String", # The name of the package.
+ },
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "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 to associate with the note
},
],
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- },
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- "severity": "A String", # The severity as specified by the upstream operating system.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "resourceUrl": "A String", # 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. # 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.
+ # This field can be used as a filter in list requests.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
},
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
- # various channels.
- # e.g. glibc (aka libc6) is distributed by many, at various versions.
- "name": "A String", # 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
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
- # this distribution channel.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ # filter in list requests.
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "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 occurrences 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
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "package": "A String", # The package being described.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "cpeUri": "A String", # 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.
+ # This field can be used as a filter in list requests.
},
- "description": "A String", # The distribution channel-specific description of this package.
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a 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
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ ],
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ # the provenance message in linked BuildDetails.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ # `BuilderDetails`.
+ "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", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "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`
},
- ],
- },
- "createTime": "A String", # Output only. The time this note was created. 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 # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
- # indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
- },
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- }</pre>
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
+ # indicate the status of the analysis. Absence of an occurrence linked to this
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ },
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` 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.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. 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 AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
+ },
+ },
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ },
+ ],
+ },
+ }</pre>
</div>
<div class="method">
@@ -946,48 +946,10 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "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.
- "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).
"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`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
@@ -1033,12 +995,12 @@
"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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
"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.
"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.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -1085,23 +1047,61 @@
#
"A String",
],
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, filter=None, name=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageSize=None, name=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all `Notes` for a given project.
Args:
parent: string, This field contains the project Id for example: "projects/{PROJECT_ID}". (required)
filter: string, The filter expression.
+ pageSize: integer, Number of notes to return in the list.
name: string, The name field will contain the project Id for example:
"providers/{provider_id}
@Deprecated
pageToken: string, Token to provide to skip to a particular spot in the list.
- pageSize: integer, Number of notes to return in the list.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1113,224 +1113,224 @@
{ # Response including listed notes.
"notes": [ # The occurrences requested
{ # Provides a detailed description of a `Note`.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- },
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
- # the provenance message in linked BuildDetails.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
- # `BuilderDetails`.
- "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).
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
- },
- "builderVersion": "A String", # Version of the builder which produced this Note.
- },
- "longDescription": "A String", # A detailed description of this `Note`.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` 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.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. 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 AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "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 occurrences 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 the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ # various channels.
+ # e.g. glibc (aka libc6) is distributed by many, at various versions.
+ "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
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
"name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "package": "A String", # The package being described.
+ "maintainer": "A String", # A freeform string denoting the maintainer of 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.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
},
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cpeUri": "A String", # 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.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
+ ],
+ "name": "A String", # The name of the package.
+ },
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "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 to associate with the note
},
],
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- },
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- "severity": "A String", # The severity as specified by the upstream operating system.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "resourceUrl": "A String", # 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. # 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.
+ # This field can be used as a filter in list requests.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
},
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
- # various channels.
- # e.g. glibc (aka libc6) is distributed by many, at various versions.
- "name": "A String", # 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
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
- # this distribution channel.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ # filter in list requests.
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "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 occurrences 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
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "package": "A String", # The package being described.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "cpeUri": "A String", # 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.
+ # This field can be used as a filter in list requests.
},
- "description": "A String", # The distribution channel-specific description of this package.
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a 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
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ ],
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ # the provenance message in linked BuildDetails.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ # `BuilderDetails`.
+ "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", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "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`
},
- ],
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
+ # indicate the status of the analysis. Absence of an occurrence linked to this
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ },
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` 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.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. 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 AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
+ },
+ },
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ },
+ ],
+ },
},
- "createTime": "A String", # Output only. The time this note was created. 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 # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
- # indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
- },
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- },
],
"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 result.
@@ -1362,239 +1362,41 @@
The object takes the form of:
{ # Provides a detailed description of a `Note`.
- "relatedUrl": [ # URLs associated with this note
- { # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
- "label": "A String", # Label to describe usage of the URL
- },
- ],
- "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
- "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
- # representation.
- # This field can be used as a filter in list requests.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
- },
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
- },
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
- "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
- # the provenance message in linked BuildDetails.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
- # `BuilderDetails`.
- "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).
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
- },
- "builderVersion": "A String", # Version of the builder which produced this Note.
- },
- "longDescription": "A String", # A detailed description of this `Note`.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "shortDescription": "A String", # A one sentence description of this `Note`.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
- # example, an organization might have one `AttestationAuthority` 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.
- "hint": { # This submessage provides human-readable hints about the purpose of the
- # AttestationAuthority. 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 AttestationAuthorities in security sensitive contexts, such as when
- # looking up Attestations to verify.
- "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
- },
- },
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "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 occurrences 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 the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ # various channels.
+ # e.g. glibc (aka libc6) is distributed by many, at various versions.
+ "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
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # this distribution channel.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
"name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "package": "A String", # The package being described.
+ "maintainer": "A String", # A freeform string denoting the maintainer of 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.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
},
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cpeUri": "A String", # 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.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- },
- ],
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- },
- "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
- # version. For each package version combination (i.e. bash 4.0, bash 4.1,
- # bash 4.1.2), there will be a Upgrade Note.
- "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
+ ],
+ "name": "A String", # The name of the package.
},
- "distributions": [ # Metadata about the upgrade for each specific operating system.
- { # The Upgrade Distribution represents metadata about the Upgrade for each
- # operating system (CPE). Some distributions have additional metadata around
- # updates, classifying them into various categories and severities.
- "classification": "A String", # The operating system classification of this Upgrade, as specified by the
- # upstream operating system upgrade feed.
- "severity": "A String", # The severity as specified by the upstream operating system.
- "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
- # https://cpe.mitre.org/specification/.
- "cve": [ # The cve that would be resolved by this upgrade.
- "A String",
- ],
- },
- ],
- "package": "A String", # Required - The package this Upgrade is for.
- },
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
- # various channels.
- # e.g. glibc (aka libc6) is distributed by many, at various versions.
- "name": "A String", # 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
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
- # this distribution channel.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "description": "A String", # The distribution channel-specific description of this package.
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a 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
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- },
- ],
- },
- "createTime": "A String", # Output only. The time this note was created. 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 # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
- # indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
- },
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
-}
-
- updateMask: string, The fields to update.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Provides a detailed description of a `Note`.
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
"relatedUrl": [ # URLs associated with this note
{ # Metadata for any related URL information
- "url": "A String", # Specific URL to associate with the note
"label": "A String", # Label to describe usage of the URL
+ "url": "A String", # Specific URL to associate with the note
},
],
"expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
@@ -1603,27 +1405,98 @@
# equivalent image via:
# FROM <Basis.resource_url>
# Or an equivalent reference, e.g. a tag of the resource_url.
+ "resourceUrl": "A String", # 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. # 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.
+ # This field can be used as a filter in list requests.
"v2Blob": [ # The ordered list of v2 blobs that represent a given image.
"A String",
],
"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
# representation.
# This field can be used as a filter in list requests.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- # This field can be used as a filter in list requests.
},
- "resourceUrl": "A String", # The resource_url for the resource representing the basis of
- # associated occurrence images.
},
- "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
- # field can be used as a filter in list requests.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ # filter in list requests.
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "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 occurrences 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
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "package": "A String", # The package being described.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "cpeUri": "A String", # 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.
+ # This field can be used as a filter in list requests.
+ },
+ ],
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ },
"buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
# the provenance message in linked BuildDetails.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
# `BuilderDetails`.
+ "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", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
"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.
@@ -1637,23 +1510,27 @@
# 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).
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`
- "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.
},
"builderVersion": "A String", # Version of the builder which produced this Note.
},
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
"longDescription": "A String", # A detailed description of this `Note`.
"deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
"resourceUri": [ # Resource URI for the artifact being deployed.
"A String",
],
},
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
"shortDescription": "A String", # A one sentence description of this `Note`.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
+ # indicate the status of the analysis. Absence of an occurrence linked to this
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ },
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
# example, an organization might have one `AttestationAuthority` for "QA" and
# one for "build". This Note is intended to act strictly as a grouping
@@ -1672,85 +1549,20 @@
"humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
},
},
- "name": "A String", # The name of the note in the form
- # "projects/{provider_project_id}/notes/{NOTE_ID}"
- "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
- "severity": "A String", # Note provider assigned impact of the vulnerability
- "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 occurrences 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 the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "package": "A String", # The package being described.
- },
- "packageType": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cpeUri": "A String", # 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.
- # This field can be used as a filter in list requests.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "package": "A String", # The name of the package where the vulnerability was found.
- # This field can be used as a filter in list requests.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- },
- ],
- "cvssScore": 3.14, # The CVSS score for this Vulnerability.
- },
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
# version. For each package version combination (i.e. bash 4.0, bash 4.1,
# bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
"version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
"name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each
@@ -1758,57 +1570,245 @@
# updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the
# upstream operating system upgrade feed.
- "severity": "A String", # The severity as specified by the upstream operating system.
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
# https://cpe.mitre.org/specification/.
+ "severity": "A String", # The severity as specified by the upstream operating system.
"cve": [ # The cve that would be resolved by this upgrade.
"A String",
],
},
],
- "package": "A String", # Required - The package this Upgrade is for.
},
- "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
- # various channels.
- # e.g. glibc (aka libc6) is distributed by many, at various versions.
- "name": "A String", # 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
- "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
- # this distribution channel.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "name": "A String", # The main part of the version name.
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
+ }
+
+ updateMask: string, The fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Provides a detailed description of a `Note`.
+ "package": { # This represents a particular package that is distributed over # A note describing a package hosted by various package managers.
+ # various channels.
+ # e.g. glibc (aka libc6) is distributed by many, at various versions.
+ "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
+ "latestVersion": { # Version contains structured information about the version of the package. # The latest available version of this package in
+ # this distribution channel.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "maintainer": "A String", # A freeform string denoting the maintainer of 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.
+ "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
+ # denoting the package manager version distributing a package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
},
- "description": "A String", # The distribution channel-specific description of this package.
- "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
- # denoting the package manager version distributing a 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
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ ],
+ "name": "A String", # The name of the package.
+ },
+ "name": "A String", # The name of the note in the form
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
+ "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 to associate with the note
},
],
- },
- "createTime": "A String", # Output only. The time this note was created. 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 # A note describing a provider/analysis type.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis. The occurrence's operation will
- # indicate the status of the analysis. Absence of an occurrence linked to this
- # note for a resource indicates that analysis hasn't started.
- "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
- },
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- }</pre>
+ "expirationTime": "A String", # Time of expiration for this note, null if note does not expire.
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
+ # relationship. Linked occurrences are derived from this or an
+ # equivalent image via:
+ # FROM <Basis.resource_url>
+ # Or an equivalent reference, e.g. a tag of the resource_url.
+ "resourceUrl": "A String", # 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. # 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.
+ # This field can be used as a filter in list requests.
+ "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
+ # representation.
+ # This field can be used as a filter in list requests.
+ },
+ },
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a
+ # filter in list requests.
+ "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "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 occurrences 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
+ "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "minAffectedVersion": { # Version contains structured information about the version of the package. # The min version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "package": "A String", # The package being described.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "package": "A String", # The name of the package where the vulnerability was found.
+ # This field can be used as a filter in list requests.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "cpeUri": "A String", # 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.
+ # This field can be used as a filter in list requests.
+ },
+ ],
+ "severity": "A String", # Note provider assigned impact of the vulnerability
+ "cvssScore": 3.14, # The CVSS score for this Vulnerability.
+ },
+ "buildType": { # Note holding the version of the provider's builder and the signature of # Build provenance type for a verifiable build.
+ # the provenance message in linked BuildDetails.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this
+ # `BuilderDetails`.
+ "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", # Signature of the related `BuildProvenance`, encoded in a base64 string.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`
+ "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`
+ },
+ "builderVersion": "A String", # Version of the builder which produced this Note.
+ },
+ "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
+ # field can be used as a filter in list requests.
+ "longDescription": "A String", # A detailed description of this `Note`.
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
+ # a filter in list requests.
+ "shortDescription": "A String", # A one sentence description of this `Note`.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing a provider/analysis type.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis. The occurrence's operation will
+ # indicate the status of the analysis. Absence of an occurrence linked to this
+ # note for a resource indicates that analysis hasn't started.
+ "analysisKind": "A String", # The kind of analysis that is handled by this discovery.
+ },
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For # A note describing an attestation role.
+ # example, an organization might have one `AttestationAuthority` 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.
+ "hint": { # This submessage provides human-readable hints about the purpose of the
+ # AttestationAuthority. 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 AttestationAuthorities in security sensitive contexts, such as when
+ # looking up Attestations to verify.
+ "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".
+ },
+ },
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "package": "A String", # Required - The package this Upgrade is for.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "name": "A String", # The main part of the version name.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ },
+ ],
+ },
+ }</pre>
</div>
<div class="method">
@@ -1903,48 +1903,10 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "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.
- "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).
"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`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
@@ -1990,12 +1952,12 @@
"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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
"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.
"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.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -2042,8 +2004,46 @@
#
"A String",
],
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "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.
},
}
@@ -2122,48 +2122,10 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "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.
- "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).
"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`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
@@ -2209,12 +2171,12 @@
"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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
"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.
"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.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -2261,8 +2223,46 @@
#
"A String",
],
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "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.
}</pre>
</div>