docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
index ce5a352..05db2ae 100644
--- a/docs/dyn/containeranalysis_v1beta1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
@@ -123,121 +123,6 @@
{ # Request to create notes in batch.
"notes": { # Required. The notes to create. Max allowed length is 1000.
"a_key": { # A type of analysis that can be done for a resource.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
- # channels. E.g., glibc (aka libc6) is distributed by many, at various
- # versions.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package.
- # E.g., Debian's jessie-backports dpkg mirror.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "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", # Required. 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.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing the initial analysis of a resource.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this
- # discovery.
- },
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "url": "A String", # Specific URL associated with the resource.
- "label": "A String", # Label to describe usage of the URL.
- },
- ],
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
- # chain step in an in-toto layout. This information goes into a Grafeas note.
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
- # artifacts that enter this supply chain step, and exit the supply chain
- # step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "signingKeys": [ # This field contains the public keys that can be used to verify the
- # signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply
- # chain. An in-toto link is attested using one or more keys defined in the
- # in-toto layout. An example of this is:
- # {
- # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
- # "key_type": "rsa",
- # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
- # "key_scheme": "rsassa-pss-sha256"
- # }
- # The format for in-toto's key definition can be found in section 4.2 of the
- # in-toto specification.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
- # and "ecdsa".
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
- # need to be used to sign the step's in-toto link.
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "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.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- },
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- },
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "longDescription": "A String", # A detailed description of this note.
- "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 `Authority` for "QA" and one for
# "build". This note is intended to act strictly as a grouping mechanism for
@@ -260,6 +145,22 @@
"name": "A String", # Output only. The name of the note in the form of
# `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
+ # For details, see https://www.first.org/cvss/specification-document
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "scope": "A String",
+ "integrityImpact": "A String",
+ "exploitabilityScore": 3.14,
+ "impactScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics
+ # Represents the intrinsic characteristics of a vulnerability that are
+ # constant over time and across user environments.
+ "confidentialityImpact": "A String",
+ },
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
# upstream timestamp from the underlying information source - e.g. Ubuntu
# security tracker.
@@ -279,14 +180,13 @@
# multiple KBs) that mitigate a given vulnerability. Currently any listed
# kb's presence is considered a fix.
{
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog -
# https://www.catalog.update.microsoft.com/
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
},
],
},
],
- "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.
@@ -303,12 +203,12 @@
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"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", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
@@ -320,48 +220,32 @@
"description": "A String", # A vendor-specific description of this note.
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
},
],
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "scope": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "attackComplexity": "A String",
- "availabilityImpact": "A String",
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "confidentialityImpact": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- },
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note
# containing build details.
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
@@ -386,7 +270,123 @@
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
},
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
},
+ "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ # channels. E.g., glibc (aka libc6) is distributed by many, at various
+ # versions.
+ "name": "A String", # Required. Immutable. The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package.
+ # E.g., Debian's jessie-backports dpkg mirror.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version
+ # name.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
+ # versions.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # Required. 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.
+ },
+ ],
+ },
+ "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 the initial analysis of a resource.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis.
+ "analysisKind": "A String", # Required. Immutable. 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.
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ },
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
+ # representation.
+ "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.
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
+ # basis of associated occurrence images.
+ },
+ "kind": "A String", # Output only. The type of analysis. 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": [ # Required. Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
},
},
}
@@ -402,121 +402,6 @@
{ # Response for creating notes in batch.
"notes": [ # The notes that were created.
{ # A type of analysis that can be done for a resource.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
- # channels. E.g., glibc (aka libc6) is distributed by many, at various
- # versions.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package.
- # E.g., Debian's jessie-backports dpkg mirror.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "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", # Required. 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.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing the initial analysis of a resource.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this
- # discovery.
- },
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "url": "A String", # Specific URL associated with the resource.
- "label": "A String", # Label to describe usage of the URL.
- },
- ],
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
- # chain step in an in-toto layout. This information goes into a Grafeas note.
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
- # artifacts that enter this supply chain step, and exit the supply chain
- # step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "signingKeys": [ # This field contains the public keys that can be used to verify the
- # signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply
- # chain. An in-toto link is attested using one or more keys defined in the
- # in-toto layout. An example of this is:
- # {
- # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
- # "key_type": "rsa",
- # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
- # "key_scheme": "rsassa-pss-sha256"
- # }
- # The format for in-toto's key definition can be found in section 4.2 of the
- # in-toto specification.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
- # and "ecdsa".
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
- # need to be used to sign the step's in-toto link.
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "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.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- },
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- },
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "longDescription": "A String", # A detailed description of this note.
- "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 `Authority` for "QA" and one for
# "build". This note is intended to act strictly as a grouping mechanism for
@@ -539,6 +424,22 @@
"name": "A String", # Output only. The name of the note in the form of
# `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
+ # For details, see https://www.first.org/cvss/specification-document
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "scope": "A String",
+ "integrityImpact": "A String",
+ "exploitabilityScore": 3.14,
+ "impactScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics
+ # Represents the intrinsic characteristics of a vulnerability that are
+ # constant over time and across user environments.
+ "confidentialityImpact": "A String",
+ },
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
# upstream timestamp from the underlying information source - e.g. Ubuntu
# security tracker.
@@ -558,14 +459,13 @@
# multiple KBs) that mitigate a given vulnerability. Currently any listed
# kb's presence is considered a fix.
{
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog -
# https://www.catalog.update.microsoft.com/
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
},
],
},
],
- "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.
@@ -582,12 +482,12 @@
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"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", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
@@ -599,48 +499,32 @@
"description": "A String", # A vendor-specific description of this note.
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
},
],
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "scope": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "attackComplexity": "A String",
- "availabilityImpact": "A String",
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "confidentialityImpact": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- },
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note
# containing build details.
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
@@ -665,7 +549,123 @@
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
},
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
},
+ "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ # channels. E.g., glibc (aka libc6) is distributed by many, at various
+ # versions.
+ "name": "A String", # Required. Immutable. The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package.
+ # E.g., Debian's jessie-backports dpkg mirror.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version
+ # name.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
+ # versions.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # Required. 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.
+ },
+ ],
+ },
+ "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 the initial analysis of a resource.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis.
+ "analysisKind": "A String", # Required. Immutable. 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.
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ },
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
+ # representation.
+ "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.
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
+ # basis of associated occurrence images.
+ },
+ "kind": "A String", # Output only. The type of analysis. 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": [ # Required. Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
},
],
}</pre>
@@ -682,121 +682,6 @@
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
- # channels. E.g., glibc (aka libc6) is distributed by many, at various
- # versions.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package.
- # E.g., Debian's jessie-backports dpkg mirror.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "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", # Required. 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.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing the initial analysis of a resource.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this
- # discovery.
- },
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "url": "A String", # Specific URL associated with the resource.
- "label": "A String", # Label to describe usage of the URL.
- },
- ],
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
- # chain step in an in-toto layout. This information goes into a Grafeas note.
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
- # artifacts that enter this supply chain step, and exit the supply chain
- # step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "signingKeys": [ # This field contains the public keys that can be used to verify the
- # signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply
- # chain. An in-toto link is attested using one or more keys defined in the
- # in-toto layout. An example of this is:
- # {
- # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
- # "key_type": "rsa",
- # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
- # "key_scheme": "rsassa-pss-sha256"
- # }
- # The format for in-toto's key definition can be found in section 4.2 of the
- # in-toto specification.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
- # and "ecdsa".
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
- # need to be used to sign the step's in-toto link.
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "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.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- },
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- },
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "longDescription": "A String", # A detailed description of this note.
- "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 `Authority` for "QA" and one for
# "build". This note is intended to act strictly as a grouping mechanism for
@@ -819,6 +704,22 @@
"name": "A String", # Output only. The name of the note in the form of
# `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
+ # For details, see https://www.first.org/cvss/specification-document
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "scope": "A String",
+ "integrityImpact": "A String",
+ "exploitabilityScore": 3.14,
+ "impactScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics
+ # Represents the intrinsic characteristics of a vulnerability that are
+ # constant over time and across user environments.
+ "confidentialityImpact": "A String",
+ },
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
# upstream timestamp from the underlying information source - e.g. Ubuntu
# security tracker.
@@ -838,14 +739,13 @@
# multiple KBs) that mitigate a given vulnerability. Currently any listed
# kb's presence is considered a fix.
{
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog -
# https://www.catalog.update.microsoft.com/
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
},
],
},
],
- "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.
@@ -862,12 +762,12 @@
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"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", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
@@ -879,48 +779,32 @@
"description": "A String", # A vendor-specific description of this note.
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
},
],
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "scope": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "attackComplexity": "A String",
- "availabilityImpact": "A String",
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "confidentialityImpact": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- },
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note
# containing build details.
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
@@ -945,7 +829,123 @@
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
},
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
},
+ "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ # channels. E.g., glibc (aka libc6) is distributed by many, at various
+ # versions.
+ "name": "A String", # Required. Immutable. The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package.
+ # E.g., Debian's jessie-backports dpkg mirror.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version
+ # name.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
+ # versions.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # Required. 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.
+ },
+ ],
+ },
+ "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 the initial analysis of a resource.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis.
+ "analysisKind": "A String", # Required. Immutable. 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.
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ },
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
+ # representation.
+ "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.
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
+ # basis of associated occurrence images.
+ },
+ "kind": "A String", # Output only. The type of analysis. 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": [ # Required. Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
}
noteId: string, Required. The ID to use for this note.
@@ -958,121 +958,6 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
- # channels. E.g., glibc (aka libc6) is distributed by many, at various
- # versions.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package.
- # E.g., Debian's jessie-backports dpkg mirror.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "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", # Required. 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.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing the initial analysis of a resource.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this
- # discovery.
- },
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "url": "A String", # Specific URL associated with the resource.
- "label": "A String", # Label to describe usage of the URL.
- },
- ],
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
- # chain step in an in-toto layout. This information goes into a Grafeas note.
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
- # artifacts that enter this supply chain step, and exit the supply chain
- # step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "signingKeys": [ # This field contains the public keys that can be used to verify the
- # signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply
- # chain. An in-toto link is attested using one or more keys defined in the
- # in-toto layout. An example of this is:
- # {
- # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
- # "key_type": "rsa",
- # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
- # "key_scheme": "rsassa-pss-sha256"
- # }
- # The format for in-toto's key definition can be found in section 4.2 of the
- # in-toto specification.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
- # and "ecdsa".
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
- # need to be used to sign the step's in-toto link.
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "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.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- },
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- },
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "longDescription": "A String", # A detailed description of this note.
- "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 `Authority` for "QA" and one for
# "build". This note is intended to act strictly as a grouping mechanism for
@@ -1095,6 +980,22 @@
"name": "A String", # Output only. The name of the note in the form of
# `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
+ # For details, see https://www.first.org/cvss/specification-document
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "scope": "A String",
+ "integrityImpact": "A String",
+ "exploitabilityScore": 3.14,
+ "impactScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics
+ # Represents the intrinsic characteristics of a vulnerability that are
+ # constant over time and across user environments.
+ "confidentialityImpact": "A String",
+ },
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
# upstream timestamp from the underlying information source - e.g. Ubuntu
# security tracker.
@@ -1114,14 +1015,13 @@
# multiple KBs) that mitigate a given vulnerability. Currently any listed
# kb's presence is considered a fix.
{
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog -
# https://www.catalog.update.microsoft.com/
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
},
],
},
],
- "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.
@@ -1138,12 +1038,12 @@
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"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", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
@@ -1155,48 +1055,32 @@
"description": "A String", # A vendor-specific description of this note.
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
},
],
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "scope": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "attackComplexity": "A String",
- "availabilityImpact": "A String",
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "confidentialityImpact": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- },
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note
# containing build details.
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
@@ -1221,7 +1105,123 @@
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
},
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
},
+ "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ # channels. E.g., glibc (aka libc6) is distributed by many, at various
+ # versions.
+ "name": "A String", # Required. Immutable. The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package.
+ # E.g., Debian's jessie-backports dpkg mirror.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version
+ # name.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
+ # versions.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # Required. 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.
+ },
+ ],
+ },
+ "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 the initial analysis of a resource.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis.
+ "analysisKind": "A String", # Required. Immutable. 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.
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ },
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
+ # representation.
+ "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.
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
+ # basis of associated occurrence images.
+ },
+ "kind": "A String", # Output only. The type of analysis. 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": [ # Required. Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
}</pre>
</div>
@@ -1268,121 +1268,6 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
- # channels. E.g., glibc (aka libc6) is distributed by many, at various
- # versions.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package.
- # E.g., Debian's jessie-backports dpkg mirror.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "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", # Required. 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.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing the initial analysis of a resource.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this
- # discovery.
- },
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "url": "A String", # Specific URL associated with the resource.
- "label": "A String", # Label to describe usage of the URL.
- },
- ],
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
- # chain step in an in-toto layout. This information goes into a Grafeas note.
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
- # artifacts that enter this supply chain step, and exit the supply chain
- # step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "signingKeys": [ # This field contains the public keys that can be used to verify the
- # signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply
- # chain. An in-toto link is attested using one or more keys defined in the
- # in-toto layout. An example of this is:
- # {
- # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
- # "key_type": "rsa",
- # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
- # "key_scheme": "rsassa-pss-sha256"
- # }
- # The format for in-toto's key definition can be found in section 4.2 of the
- # in-toto specification.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
- # and "ecdsa".
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
- # need to be used to sign the step's in-toto link.
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "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.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- },
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- },
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "longDescription": "A String", # A detailed description of this note.
- "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 `Authority` for "QA" and one for
# "build". This note is intended to act strictly as a grouping mechanism for
@@ -1405,6 +1290,22 @@
"name": "A String", # Output only. The name of the note in the form of
# `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
+ # For details, see https://www.first.org/cvss/specification-document
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "scope": "A String",
+ "integrityImpact": "A String",
+ "exploitabilityScore": 3.14,
+ "impactScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics
+ # Represents the intrinsic characteristics of a vulnerability that are
+ # constant over time and across user environments.
+ "confidentialityImpact": "A String",
+ },
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
# upstream timestamp from the underlying information source - e.g. Ubuntu
# security tracker.
@@ -1424,14 +1325,13 @@
# multiple KBs) that mitigate a given vulnerability. Currently any listed
# kb's presence is considered a fix.
{
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog -
# https://www.catalog.update.microsoft.com/
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
},
],
},
],
- "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.
@@ -1448,12 +1348,12 @@
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"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", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
@@ -1465,48 +1365,32 @@
"description": "A String", # A vendor-specific description of this note.
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
},
],
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "scope": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "attackComplexity": "A String",
- "availabilityImpact": "A String",
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "confidentialityImpact": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- },
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note
# containing build details.
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
@@ -1531,7 +1415,123 @@
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
},
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
},
+ "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ # channels. E.g., glibc (aka libc6) is distributed by many, at various
+ # versions.
+ "name": "A String", # Required. Immutable. The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package.
+ # E.g., Debian's jessie-backports dpkg mirror.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version
+ # name.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
+ # versions.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # Required. 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.
+ },
+ ],
+ },
+ "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 the initial analysis of a resource.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis.
+ "analysisKind": "A String", # Required. Immutable. 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.
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ },
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
+ # representation.
+ "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.
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
+ # basis of associated occurrence images.
+ },
+ "kind": "A String", # Output only. The type of analysis. 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": [ # Required. Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
}</pre>
</div>
@@ -1645,6 +1645,18 @@
#
# 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
@@ -1673,6 +1685,58 @@
# `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`.
+ "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
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "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.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -1720,72 +1784,8 @@
],
"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
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "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.
- },
},
],
- "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>
@@ -1809,126 +1809,8 @@
An object of the form:
{ # Response for listing notes.
- "nextPageToken": "A String", # The next pagination token in the list response. It should be used as
- # `page_token` for the following request. An empty value means no more
- # results.
"notes": [ # The notes requested.
{ # A type of analysis that can be done for a resource.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
- # channels. E.g., glibc (aka libc6) is distributed by many, at various
- # versions.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package.
- # E.g., Debian's jessie-backports dpkg mirror.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "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", # Required. 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.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing the initial analysis of a resource.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this
- # discovery.
- },
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "url": "A String", # Specific URL associated with the resource.
- "label": "A String", # Label to describe usage of the URL.
- },
- ],
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
- # chain step in an in-toto layout. This information goes into a Grafeas note.
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
- # artifacts that enter this supply chain step, and exit the supply chain
- # step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "signingKeys": [ # This field contains the public keys that can be used to verify the
- # signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply
- # chain. An in-toto link is attested using one or more keys defined in the
- # in-toto layout. An example of this is:
- # {
- # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
- # "key_type": "rsa",
- # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
- # "key_scheme": "rsassa-pss-sha256"
- # }
- # The format for in-toto's key definition can be found in section 4.2 of the
- # in-toto specification.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
- # and "ecdsa".
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
- # need to be used to sign the step's in-toto link.
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "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.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- },
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- },
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "longDescription": "A String", # A detailed description of this note.
- "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 `Authority` for "QA" and one for
# "build". This note is intended to act strictly as a grouping mechanism for
@@ -1951,6 +1833,22 @@
"name": "A String", # Output only. The name of the note in the form of
# `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
+ # For details, see https://www.first.org/cvss/specification-document
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "scope": "A String",
+ "integrityImpact": "A String",
+ "exploitabilityScore": 3.14,
+ "impactScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics
+ # Represents the intrinsic characteristics of a vulnerability that are
+ # constant over time and across user environments.
+ "confidentialityImpact": "A String",
+ },
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
# upstream timestamp from the underlying information source - e.g. Ubuntu
# security tracker.
@@ -1970,14 +1868,13 @@
# multiple KBs) that mitigate a given vulnerability. Currently any listed
# kb's presence is considered a fix.
{
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog -
# https://www.catalog.update.microsoft.com/
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
},
],
},
],
- "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.
@@ -1994,12 +1891,12 @@
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"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", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
@@ -2011,48 +1908,32 @@
"description": "A String", # A vendor-specific description of this note.
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
},
],
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "scope": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "attackComplexity": "A String",
- "availabilityImpact": "A String",
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "confidentialityImpact": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- },
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note
# containing build details.
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
@@ -2077,9 +1958,128 @@
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
},
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
},
+ "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ # channels. E.g., glibc (aka libc6) is distributed by many, at various
+ # versions.
+ "name": "A String", # Required. Immutable. The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package.
+ # E.g., Debian's jessie-backports dpkg mirror.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version
+ # name.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
+ # versions.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # Required. 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.
+ },
+ ],
+ },
+ "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 the initial analysis of a resource.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis.
+ "analysisKind": "A String", # Required. Immutable. 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.
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ },
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
+ # representation.
+ "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.
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
+ # basis of associated occurrence images.
+ },
+ "kind": "A String", # Output only. The type of analysis. 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": [ # Required. Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
},
],
+ "nextPageToken": "A String", # The next pagination token in the list response. It should be used as
+ # `page_token` for the following request. An empty value means no more
+ # results.
}</pre>
</div>
@@ -2108,121 +2108,6 @@
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
- # channels. E.g., glibc (aka libc6) is distributed by many, at various
- # versions.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package.
- # E.g., Debian's jessie-backports dpkg mirror.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "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", # Required. 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.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing the initial analysis of a resource.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this
- # discovery.
- },
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "url": "A String", # Specific URL associated with the resource.
- "label": "A String", # Label to describe usage of the URL.
- },
- ],
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
- # chain step in an in-toto layout. This information goes into a Grafeas note.
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
- # artifacts that enter this supply chain step, and exit the supply chain
- # step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "signingKeys": [ # This field contains the public keys that can be used to verify the
- # signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply
- # chain. An in-toto link is attested using one or more keys defined in the
- # in-toto layout. An example of this is:
- # {
- # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
- # "key_type": "rsa",
- # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
- # "key_scheme": "rsassa-pss-sha256"
- # }
- # The format for in-toto's key definition can be found in section 4.2 of the
- # in-toto specification.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
- # and "ecdsa".
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
- # need to be used to sign the step's in-toto link.
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "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.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- },
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- },
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "longDescription": "A String", # A detailed description of this note.
- "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 `Authority` for "QA" and one for
# "build". This note is intended to act strictly as a grouping mechanism for
@@ -2245,6 +2130,22 @@
"name": "A String", # Output only. The name of the note in the form of
# `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
+ # For details, see https://www.first.org/cvss/specification-document
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "scope": "A String",
+ "integrityImpact": "A String",
+ "exploitabilityScore": 3.14,
+ "impactScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics
+ # Represents the intrinsic characteristics of a vulnerability that are
+ # constant over time and across user environments.
+ "confidentialityImpact": "A String",
+ },
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
# upstream timestamp from the underlying information source - e.g. Ubuntu
# security tracker.
@@ -2264,14 +2165,13 @@
# multiple KBs) that mitigate a given vulnerability. Currently any listed
# kb's presence is considered a fix.
{
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog -
# https://www.catalog.update.microsoft.com/
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
},
],
},
],
- "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.
@@ -2288,12 +2188,12 @@
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"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", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
@@ -2305,48 +2205,32 @@
"description": "A String", # A vendor-specific description of this note.
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
},
],
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "scope": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "attackComplexity": "A String",
- "availabilityImpact": "A String",
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "confidentialityImpact": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- },
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note
# containing build details.
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
@@ -2371,7 +2255,123 @@
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
},
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
},
+ "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ # channels. E.g., glibc (aka libc6) is distributed by many, at various
+ # versions.
+ "name": "A String", # Required. Immutable. The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package.
+ # E.g., Debian's jessie-backports dpkg mirror.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version
+ # name.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
+ # versions.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # Required. 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.
+ },
+ ],
+ },
+ "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 the initial analysis of a resource.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis.
+ "analysisKind": "A String", # Required. Immutable. 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.
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ },
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
+ # representation.
+ "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.
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
+ # basis of associated occurrence images.
+ },
+ "kind": "A String", # Output only. The type of analysis. 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": [ # Required. Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
}
updateMask: string, The fields to update.
@@ -2384,121 +2384,6 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
- # channels. E.g., glibc (aka libc6) is distributed by many, at various
- # versions.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package.
- # E.g., Debian's jessie-backports dpkg mirror.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "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", # Required. 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.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note # A note describing the initial analysis of a resource.
- # exists in a provider's project. A `Discovery` occurrence is created in a
- # consumer's project at the start of analysis.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this
- # discovery.
- },
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "url": "A String", # Specific URL associated with the resource.
- "label": "A String", # Label to describe usage of the URL.
- },
- ],
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
- # chain step in an in-toto layout. This information goes into a Grafeas note.
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
- # artifacts that enter this supply chain step, and exit the supply chain
- # step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "signingKeys": [ # This field contains the public keys that can be used to verify the
- # signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply
- # chain. An in-toto link is attested using one or more keys defined in the
- # in-toto layout. An example of this is:
- # {
- # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
- # "key_type": "rsa",
- # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
- # "key_scheme": "rsassa-pss-sha256"
- # }
- # The format for in-toto's key definition can be found in section 4.2 of the
- # in-toto specification.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
- # and "ecdsa".
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
- # need to be used to sign the step's in-toto link.
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "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.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- },
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- },
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "longDescription": "A String", # A detailed description of this note.
- "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 `Authority` for "QA" and one for
# "build". This note is intended to act strictly as a grouping mechanism for
@@ -2521,6 +2406,22 @@
"name": "A String", # Output only. The name of the note in the form of
# `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
+ # For details, see https://www.first.org/cvss/specification-document
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "scope": "A String",
+ "integrityImpact": "A String",
+ "exploitabilityScore": 3.14,
+ "impactScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics
+ # Represents the intrinsic characteristics of a vulnerability that are
+ # constant over time and across user environments.
+ "confidentialityImpact": "A String",
+ },
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
# upstream timestamp from the underlying information source - e.g. Ubuntu
# security tracker.
@@ -2540,14 +2441,13 @@
# multiple KBs) that mitigate a given vulnerability. Currently any listed
# kb's presence is considered a fix.
{
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog -
# https://www.catalog.update.microsoft.com/
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
},
],
},
],
- "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.
@@ -2564,12 +2464,12 @@
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"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", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
@@ -2581,48 +2481,32 @@
"description": "A String", # A vendor-specific description of this note.
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version
# name.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
},
],
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "scope": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "attackComplexity": "A String",
- "availabilityImpact": "A String",
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "confidentialityImpact": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- },
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note
# containing build details.
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
@@ -2647,7 +2531,123 @@
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
},
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
},
+ "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ # channels. E.g., glibc (aka libc6) is distributed by many, at various
+ # versions.
+ "name": "A String", # Required. Immutable. The name of the package.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package.
+ # E.g., Debian's jessie-backports dpkg mirror.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version
+ # name.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
+ # versions.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ },
+ "description": "A String", # The distribution channel-specific description of this package.
+ "cpeUri": "A String", # Required. 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.
+ },
+ ],
+ },
+ "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 the initial analysis of a resource.
+ # exists in a provider's project. A `Discovery` occurrence is created in a
+ # consumer's project at the start of analysis.
+ "analysisKind": "A String", # Required. Immutable. 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.
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ },
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
+ },
+ ],
+ "expirationTime": "A String", # Time of expiration for this note. Empty 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. # Required. Immutable. The fingerprint of the base image.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
+ # representation.
+ "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.
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
+ # basis of associated occurrence images.
+ },
+ "kind": "A String", # Output only. The type of analysis. 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": [ # Required. Resource URI for the artifact being deployed.
+ "A String",
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
}</pre>
</div>
@@ -2739,6 +2739,18 @@
#
# 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
@@ -2767,6 +2779,58 @@
# `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`.
+ "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
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "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.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -2814,72 +2878,8 @@
],
"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
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "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.
- },
},
],
- "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.
},
}
@@ -2958,6 +2958,18 @@
#
# 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
@@ -2986,6 +2998,58 @@
# `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`.
+ "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
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "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.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -3033,72 +3097,8 @@
],
"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
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "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.
- },
},
],
- "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>