docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
index d399823..ce5a352 100644
--- a/docs/dyn/containeranalysis_v1beta1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
@@ -95,7 +95,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a note or an occurrence resource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists notes for the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -121,217 +121,254 @@
The object takes the form of:
{ # 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.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedNoteNames": [ # Other notes related to this note.
- "A String",
- ],
- "name": "A String", # Output only. The name of the note in the form of
- # `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ "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.
- "distribution": [ # The various channels by which a package is distributed.
+ "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.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
+ # 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.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were
+ "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.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
},
],
- "name": "A String", # Required. Immutable. The name of the package.
},
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and
- # model don't match a normal detail. Specifically Windows updates are done as
- # patches, thus Windows vulnerabilities really are a missing package, rather
- # than a package being at an incorrect version.
- {
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
- # vulnerability. Note that there may be multiple hotfixes (and thus
- # multiple KBs) that mitigate a given vulnerability. Currently any listed
- # kb's presence is considered a fix.
- {
- "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).
- },
- ],
- "name": "A String", # Required. The name of the vulnerability.
- "description": "A String", # The description of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "availabilityImpact": "A String",
- "impactScore": 3.14,
- "exploitabilityScore": 3.14,
- "scope": "A String",
- "integrityImpact": "A String",
- "confidentialityImpact": "A String",
- },
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- "details": [ # All information about the package to specifically identify this
- # vulnerability. One entry per (version range and cpe_uri) the package
- # vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a
- # specific distro/location. For example: glibc in
- # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "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.
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
- # packages etc).
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
- # upstream timestamp from the underlying information source - e.g. Ubuntu
- # security tracker.
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package 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.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # Required. The package being described.
- },
- },
- ],
- "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.
+ "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.
},
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "relatedUrl": [ # URLs associated with this note.
+ "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.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
},
],
- "longDescription": "A String", # A detailed 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
- # the attached occurrences (Attestations). This grouping mechanism also
- # provides a security boundary, since IAM ACLs gate the ability for a principle
- # to attach an occurrence to a given note. It also provides a single point of
- # lookup to find all attached attestation occurrences, even if they don't all
- # live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
- # authority. Because the name of a note acts as its resource reference, it is
- # important to disambiguate the canonical name of the Note (which might be a
- # UUID for security purposes) from "readable" names more suitable for debug
- # output. Note that these hints should not be used to look up authorities in
- # security sensitive contexts, such as when looking up attestations to
- # verify.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
- # example "qa".
- },
- },
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ "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.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "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
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "expectedProducts": [
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "signingKeys": [ # This field contains the public keys that can be used to verify the
+ "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"
+ # "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
+ # 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".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
+ "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.
},
- "build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
+ "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
+ # the attached occurrences (Attestations). This grouping mechanism also
+ # provides a security boundary, since IAM ACLs gate the ability for a principle
+ # to attach an occurrence to a given note. It also provides a single point of
+ # lookup to find all attached attestation occurrences, even if they don't all
+ # live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
+ # authority. Because the name of a note acts as its resource reference, it is
+ # important to disambiguate the canonical name of the Note (which might be a
+ # UUID for security purposes) from "readable" names more suitable for debug
+ # output. Note that these hints should not be used to look up authorities in
+ # security sensitive contexts, such as when looking up attestations to
+ # verify.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
+ # example "qa".
+ },
+ },
+ "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.
+ "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.
+ "windowsDetails": [ # Windows details get their own format because the information format and
+ # model don't match a normal detail. Specifically Windows updates are done as
+ # patches, thus Windows vulnerabilities really are a missing package, rather
+ # than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
+ # vulnerability. Note that there may be multiple hotfixes (and thus
+ # multiple KBs) that mitigate a given vulnerability. Currently any listed
+ # kb's presence is considered a fix.
+ {
+ "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.
+ { # Identifies all appearances of this vulnerability in the package for a
+ # specific distro/location. For example: glibc in
+ # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "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.
+ "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.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # 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.
+ "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.
+ "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.
+ },
+ ],
+ "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
+ "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.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
+ # base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -344,49 +381,12 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
# stored in `public_key` (such as the ID or fingerprint for a PGP key, or the
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
- # base-64 encoded.
},
},
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "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.
- "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.
- },
},
},
}
@@ -400,217 +400,254 @@
An object of the form:
{ # Response for creating notes in batch.
- "notes": [ # The notes that were created.
+ "notes": [ # The notes that were created.
{ # A type of analysis that can be done for a resource.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedNoteNames": [ # Other notes related to this note.
- "A String",
- ],
- "name": "A String", # Output only. The name of the note in the form of
- # `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ "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.
- "distribution": [ # The various channels by which a package is distributed.
+ "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.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
+ # 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.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were
+ "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.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
},
],
- "name": "A String", # Required. Immutable. The name of the package.
},
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and
- # model don't match a normal detail. Specifically Windows updates are done as
- # patches, thus Windows vulnerabilities really are a missing package, rather
- # than a package being at an incorrect version.
- {
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
- # vulnerability. Note that there may be multiple hotfixes (and thus
- # multiple KBs) that mitigate a given vulnerability. Currently any listed
- # kb's presence is considered a fix.
- {
- "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).
- },
- ],
- "name": "A String", # Required. The name of the vulnerability.
- "description": "A String", # The description of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "availabilityImpact": "A String",
- "impactScore": 3.14,
- "exploitabilityScore": 3.14,
- "scope": "A String",
- "integrityImpact": "A String",
- "confidentialityImpact": "A String",
- },
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- "details": [ # All information about the package to specifically identify this
- # vulnerability. One entry per (version range and cpe_uri) the package
- # vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a
- # specific distro/location. For example: glibc in
- # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "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.
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
- # packages etc).
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
- # upstream timestamp from the underlying information source - e.g. Ubuntu
- # security tracker.
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package 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.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # Required. The package being described.
- },
- },
- ],
- "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.
+ "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.
},
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "relatedUrl": [ # URLs associated with this note.
+ "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.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
},
],
- "longDescription": "A String", # A detailed 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
- # the attached occurrences (Attestations). This grouping mechanism also
- # provides a security boundary, since IAM ACLs gate the ability for a principle
- # to attach an occurrence to a given note. It also provides a single point of
- # lookup to find all attached attestation occurrences, even if they don't all
- # live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
- # authority. Because the name of a note acts as its resource reference, it is
- # important to disambiguate the canonical name of the Note (which might be a
- # UUID for security purposes) from "readable" names more suitable for debug
- # output. Note that these hints should not be used to look up authorities in
- # security sensitive contexts, such as when looking up attestations to
- # verify.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
- # example "qa".
- },
- },
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ "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.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "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
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "expectedProducts": [
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "signingKeys": [ # This field contains the public keys that can be used to verify the
+ "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"
+ # "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
+ # 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".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
+ "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.
},
- "build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
+ "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
+ # the attached occurrences (Attestations). This grouping mechanism also
+ # provides a security boundary, since IAM ACLs gate the ability for a principle
+ # to attach an occurrence to a given note. It also provides a single point of
+ # lookup to find all attached attestation occurrences, even if they don't all
+ # live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
+ # authority. Because the name of a note acts as its resource reference, it is
+ # important to disambiguate the canonical name of the Note (which might be a
+ # UUID for security purposes) from "readable" names more suitable for debug
+ # output. Note that these hints should not be used to look up authorities in
+ # security sensitive contexts, such as when looking up attestations to
+ # verify.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
+ # example "qa".
+ },
+ },
+ "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.
+ "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.
+ "windowsDetails": [ # Windows details get their own format because the information format and
+ # model don't match a normal detail. Specifically Windows updates are done as
+ # patches, thus Windows vulnerabilities really are a missing package, rather
+ # than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
+ # vulnerability. Note that there may be multiple hotfixes (and thus
+ # multiple KBs) that mitigate a given vulnerability. Currently any listed
+ # kb's presence is considered a fix.
+ {
+ "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.
+ { # Identifies all appearances of this vulnerability in the package for a
+ # specific distro/location. For example: glibc in
+ # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "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.
+ "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.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # 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.
+ "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.
+ "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.
+ },
+ ],
+ "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
+ "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.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
+ # base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -623,49 +660,12 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
# stored in `public_key` (such as the ID or fingerprint for a PGP key, or the
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
- # base-64 encoded.
},
},
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "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.
- "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.
- },
},
],
}</pre>
@@ -682,215 +682,252 @@
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedNoteNames": [ # Other notes related to this note.
- "A String",
- ],
- "name": "A String", # Output only. The name of the note in the form of
- # `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ "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.
- "distribution": [ # The various channels by which a package is distributed.
+ "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.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
+ # 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.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were
+ "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.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
},
],
- "name": "A String", # Required. Immutable. The name of the package.
},
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and
- # model don't match a normal detail. Specifically Windows updates are done as
- # patches, thus Windows vulnerabilities really are a missing package, rather
- # than a package being at an incorrect version.
- {
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
- # vulnerability. Note that there may be multiple hotfixes (and thus
- # multiple KBs) that mitigate a given vulnerability. Currently any listed
- # kb's presence is considered a fix.
- {
- "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).
- },
- ],
- "name": "A String", # Required. The name of the vulnerability.
- "description": "A String", # The description of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "availabilityImpact": "A String",
- "impactScore": 3.14,
- "exploitabilityScore": 3.14,
- "scope": "A String",
- "integrityImpact": "A String",
- "confidentialityImpact": "A String",
- },
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- "details": [ # All information about the package to specifically identify this
- # vulnerability. One entry per (version range and cpe_uri) the package
- # vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a
- # specific distro/location. For example: glibc in
- # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "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.
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
- # packages etc).
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
- # upstream timestamp from the underlying information source - e.g. Ubuntu
- # security tracker.
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package 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.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # Required. The package being described.
- },
- },
- ],
- "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.
+ "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.
},
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "relatedUrl": [ # URLs associated with this note.
+ "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.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
},
],
- "longDescription": "A String", # A detailed 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
- # the attached occurrences (Attestations). This grouping mechanism also
- # provides a security boundary, since IAM ACLs gate the ability for a principle
- # to attach an occurrence to a given note. It also provides a single point of
- # lookup to find all attached attestation occurrences, even if they don't all
- # live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
- # authority. Because the name of a note acts as its resource reference, it is
- # important to disambiguate the canonical name of the Note (which might be a
- # UUID for security purposes) from "readable" names more suitable for debug
- # output. Note that these hints should not be used to look up authorities in
- # security sensitive contexts, such as when looking up attestations to
- # verify.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
- # example "qa".
- },
- },
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ "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.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "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
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "expectedProducts": [
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "signingKeys": [ # This field contains the public keys that can be used to verify the
+ "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"
+ # "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
+ # 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".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
+ "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.
},
- "build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
+ "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
+ # the attached occurrences (Attestations). This grouping mechanism also
+ # provides a security boundary, since IAM ACLs gate the ability for a principle
+ # to attach an occurrence to a given note. It also provides a single point of
+ # lookup to find all attached attestation occurrences, even if they don't all
+ # live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
+ # authority. Because the name of a note acts as its resource reference, it is
+ # important to disambiguate the canonical name of the Note (which might be a
+ # UUID for security purposes) from "readable" names more suitable for debug
+ # output. Note that these hints should not be used to look up authorities in
+ # security sensitive contexts, such as when looking up attestations to
+ # verify.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
+ # example "qa".
+ },
+ },
+ "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.
+ "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.
+ "windowsDetails": [ # Windows details get their own format because the information format and
+ # model don't match a normal detail. Specifically Windows updates are done as
+ # patches, thus Windows vulnerabilities really are a missing package, rather
+ # than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
+ # vulnerability. Note that there may be multiple hotfixes (and thus
+ # multiple KBs) that mitigate a given vulnerability. Currently any listed
+ # kb's presence is considered a fix.
+ {
+ "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.
+ { # Identifies all appearances of this vulnerability in the package for a
+ # specific distro/location. For example: glibc in
+ # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "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.
+ "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.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # 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.
+ "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.
+ "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.
+ },
+ ],
+ "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
+ "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.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
+ # base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -903,49 +940,12 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
# stored in `public_key` (such as the ID or fingerprint for a PGP key, or the
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
- # base-64 encoded.
},
},
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "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.
- "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.
- },
}
noteId: string, Required. The ID to use for this note.
@@ -958,215 +958,252 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedNoteNames": [ # Other notes related to this note.
- "A String",
- ],
- "name": "A String", # Output only. The name of the note in the form of
- # `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ "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.
- "distribution": [ # The various channels by which a package is distributed.
+ "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.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
+ # 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.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were
+ "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.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
},
],
- "name": "A String", # Required. Immutable. The name of the package.
},
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and
- # model don't match a normal detail. Specifically Windows updates are done as
- # patches, thus Windows vulnerabilities really are a missing package, rather
- # than a package being at an incorrect version.
- {
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
- # vulnerability. Note that there may be multiple hotfixes (and thus
- # multiple KBs) that mitigate a given vulnerability. Currently any listed
- # kb's presence is considered a fix.
- {
- "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).
- },
- ],
- "name": "A String", # Required. The name of the vulnerability.
- "description": "A String", # The description of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "availabilityImpact": "A String",
- "impactScore": 3.14,
- "exploitabilityScore": 3.14,
- "scope": "A String",
- "integrityImpact": "A String",
- "confidentialityImpact": "A String",
- },
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- "details": [ # All information about the package to specifically identify this
- # vulnerability. One entry per (version range and cpe_uri) the package
- # vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a
- # specific distro/location. For example: glibc in
- # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "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.
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
- # packages etc).
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
- # upstream timestamp from the underlying information source - e.g. Ubuntu
- # security tracker.
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package 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.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # Required. The package being described.
- },
- },
- ],
- "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.
+ "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.
},
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "relatedUrl": [ # URLs associated with this note.
+ "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.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
},
],
- "longDescription": "A String", # A detailed 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
- # the attached occurrences (Attestations). This grouping mechanism also
- # provides a security boundary, since IAM ACLs gate the ability for a principle
- # to attach an occurrence to a given note. It also provides a single point of
- # lookup to find all attached attestation occurrences, even if they don't all
- # live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
- # authority. Because the name of a note acts as its resource reference, it is
- # important to disambiguate the canonical name of the Note (which might be a
- # UUID for security purposes) from "readable" names more suitable for debug
- # output. Note that these hints should not be used to look up authorities in
- # security sensitive contexts, such as when looking up attestations to
- # verify.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
- # example "qa".
- },
- },
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ "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.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "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
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "expectedProducts": [
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "signingKeys": [ # This field contains the public keys that can be used to verify the
+ "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"
+ # "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
+ # 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".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
+ "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.
},
- "build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
+ "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
+ # the attached occurrences (Attestations). This grouping mechanism also
+ # provides a security boundary, since IAM ACLs gate the ability for a principle
+ # to attach an occurrence to a given note. It also provides a single point of
+ # lookup to find all attached attestation occurrences, even if they don't all
+ # live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
+ # authority. Because the name of a note acts as its resource reference, it is
+ # important to disambiguate the canonical name of the Note (which might be a
+ # UUID for security purposes) from "readable" names more suitable for debug
+ # output. Note that these hints should not be used to look up authorities in
+ # security sensitive contexts, such as when looking up attestations to
+ # verify.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
+ # example "qa".
+ },
+ },
+ "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.
+ "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.
+ "windowsDetails": [ # Windows details get their own format because the information format and
+ # model don't match a normal detail. Specifically Windows updates are done as
+ # patches, thus Windows vulnerabilities really are a missing package, rather
+ # than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
+ # vulnerability. Note that there may be multiple hotfixes (and thus
+ # multiple KBs) that mitigate a given vulnerability. Currently any listed
+ # kb's presence is considered a fix.
+ {
+ "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.
+ { # Identifies all appearances of this vulnerability in the package for a
+ # specific distro/location. For example: glibc in
+ # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "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.
+ "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.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # 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.
+ "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.
+ "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.
+ },
+ ],
+ "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
+ "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.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
+ # base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -1179,49 +1216,12 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
# stored in `public_key` (such as the ID or fingerprint for a PGP key, or the
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
- # base-64 encoded.
},
},
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "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.
- "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.
- },
}</pre>
</div>
@@ -1268,215 +1268,252 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedNoteNames": [ # Other notes related to this note.
- "A String",
- ],
- "name": "A String", # Output only. The name of the note in the form of
- # `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ "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.
- "distribution": [ # The various channels by which a package is distributed.
+ "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.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
+ # 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.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were
+ "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.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
},
],
- "name": "A String", # Required. Immutable. The name of the package.
},
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and
- # model don't match a normal detail. Specifically Windows updates are done as
- # patches, thus Windows vulnerabilities really are a missing package, rather
- # than a package being at an incorrect version.
- {
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
- # vulnerability. Note that there may be multiple hotfixes (and thus
- # multiple KBs) that mitigate a given vulnerability. Currently any listed
- # kb's presence is considered a fix.
- {
- "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).
- },
- ],
- "name": "A String", # Required. The name of the vulnerability.
- "description": "A String", # The description of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "availabilityImpact": "A String",
- "impactScore": 3.14,
- "exploitabilityScore": 3.14,
- "scope": "A String",
- "integrityImpact": "A String",
- "confidentialityImpact": "A String",
- },
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- "details": [ # All information about the package to specifically identify this
- # vulnerability. One entry per (version range and cpe_uri) the package
- # vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a
- # specific distro/location. For example: glibc in
- # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "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.
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
- # packages etc).
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
- # upstream timestamp from the underlying information source - e.g. Ubuntu
- # security tracker.
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package 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.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # Required. The package being described.
- },
- },
- ],
- "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.
+ "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.
},
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "relatedUrl": [ # URLs associated with this note.
+ "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.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
},
],
- "longDescription": "A String", # A detailed 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
- # the attached occurrences (Attestations). This grouping mechanism also
- # provides a security boundary, since IAM ACLs gate the ability for a principle
- # to attach an occurrence to a given note. It also provides a single point of
- # lookup to find all attached attestation occurrences, even if they don't all
- # live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
- # authority. Because the name of a note acts as its resource reference, it is
- # important to disambiguate the canonical name of the Note (which might be a
- # UUID for security purposes) from "readable" names more suitable for debug
- # output. Note that these hints should not be used to look up authorities in
- # security sensitive contexts, such as when looking up attestations to
- # verify.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
- # example "qa".
- },
- },
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ "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.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "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
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "expectedProducts": [
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "signingKeys": [ # This field contains the public keys that can be used to verify the
+ "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"
+ # "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
+ # 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".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
+ "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.
},
- "build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
+ "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
+ # the attached occurrences (Attestations). This grouping mechanism also
+ # provides a security boundary, since IAM ACLs gate the ability for a principle
+ # to attach an occurrence to a given note. It also provides a single point of
+ # lookup to find all attached attestation occurrences, even if they don't all
+ # live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
+ # authority. Because the name of a note acts as its resource reference, it is
+ # important to disambiguate the canonical name of the Note (which might be a
+ # UUID for security purposes) from "readable" names more suitable for debug
+ # output. Note that these hints should not be used to look up authorities in
+ # security sensitive contexts, such as when looking up attestations to
+ # verify.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
+ # example "qa".
+ },
+ },
+ "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.
+ "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.
+ "windowsDetails": [ # Windows details get their own format because the information format and
+ # model don't match a normal detail. Specifically Windows updates are done as
+ # patches, thus Windows vulnerabilities really are a missing package, rather
+ # than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
+ # vulnerability. Note that there may be multiple hotfixes (and thus
+ # multiple KBs) that mitigate a given vulnerability. Currently any listed
+ # kb's presence is considered a fix.
+ {
+ "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.
+ { # Identifies all appearances of this vulnerability in the package for a
+ # specific distro/location. For example: glibc in
+ # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "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.
+ "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.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # 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.
+ "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.
+ "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.
+ },
+ ],
+ "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
+ "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.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
+ # base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -1489,49 +1526,12 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
# stored in `public_key` (such as the ID or fingerprint for a PGP key, or the
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
- # base-64 encoded.
},
},
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "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.
- "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.
- },
}</pre>
</div>
@@ -1553,9 +1553,9 @@
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
- "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
# `GetIamPolicy`.
- "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
+ "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
#
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
@@ -1563,6 +1563,10 @@
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value or
# leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -1584,36 +1588,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1631,63 +1639,41 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # 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.
- "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.
- "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.
- },
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -1730,11 +1716,65 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
+ "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
+ "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
@@ -1746,264 +1786,280 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
<pre>Lists notes for the specified project.
Args:
parent: string, Required. The name of the project to list notes for in the form of
`projects/[PROJECT_ID]`. (required)
pageToken: string, Token to provide to skip to a particular spot in the list.
+ pageSize: integer, Number of notes to return in the list. Must be positive. Max allowed page
+size is 1000. If not specified, page size defaults to 20.
+ filter: string, The filter expression.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: integer, Number of notes to return in the list. Must be positive. Max allowed page
-size is 1000. If not specified, page size defaults to 20.
- filter: string, The filter expression.
Returns:
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
+ "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.
+ "notes": [ # The notes requested.
{ # A type of analysis that can be done for a resource.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedNoteNames": [ # Other notes related to this note.
- "A String",
- ],
- "name": "A String", # Output only. The name of the note in the form of
- # `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ "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.
- "distribution": [ # The various channels by which a package is distributed.
+ "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.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
+ # 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.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were
+ "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.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
},
],
- "name": "A String", # Required. Immutable. The name of the package.
},
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and
- # model don't match a normal detail. Specifically Windows updates are done as
- # patches, thus Windows vulnerabilities really are a missing package, rather
- # than a package being at an incorrect version.
- {
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
- # vulnerability. Note that there may be multiple hotfixes (and thus
- # multiple KBs) that mitigate a given vulnerability. Currently any listed
- # kb's presence is considered a fix.
- {
- "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).
- },
- ],
- "name": "A String", # Required. The name of the vulnerability.
- "description": "A String", # The description of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "availabilityImpact": "A String",
- "impactScore": 3.14,
- "exploitabilityScore": 3.14,
- "scope": "A String",
- "integrityImpact": "A String",
- "confidentialityImpact": "A String",
- },
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- "details": [ # All information about the package to specifically identify this
- # vulnerability. One entry per (version range and cpe_uri) the package
- # vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a
- # specific distro/location. For example: glibc in
- # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "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.
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
- # packages etc).
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
- # upstream timestamp from the underlying information source - e.g. Ubuntu
- # security tracker.
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package 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.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # Required. The package being described.
- },
- },
- ],
- "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.
+ "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.
},
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "relatedUrl": [ # URLs associated with this note.
+ "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.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
},
],
- "longDescription": "A String", # A detailed 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
- # the attached occurrences (Attestations). This grouping mechanism also
- # provides a security boundary, since IAM ACLs gate the ability for a principle
- # to attach an occurrence to a given note. It also provides a single point of
- # lookup to find all attached attestation occurrences, even if they don't all
- # live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
- # authority. Because the name of a note acts as its resource reference, it is
- # important to disambiguate the canonical name of the Note (which might be a
- # UUID for security purposes) from "readable" names more suitable for debug
- # output. Note that these hints should not be used to look up authorities in
- # security sensitive contexts, such as when looking up attestations to
- # verify.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
- # example "qa".
- },
- },
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ "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.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "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
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "expectedProducts": [
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "signingKeys": [ # This field contains the public keys that can be used to verify the
+ "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"
+ # "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
+ # 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".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
+ "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.
},
- "build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
+ "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
+ # the attached occurrences (Attestations). This grouping mechanism also
+ # provides a security boundary, since IAM ACLs gate the ability for a principle
+ # to attach an occurrence to a given note. It also provides a single point of
+ # lookup to find all attached attestation occurrences, even if they don't all
+ # live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
+ # authority. Because the name of a note acts as its resource reference, it is
+ # important to disambiguate the canonical name of the Note (which might be a
+ # UUID for security purposes) from "readable" names more suitable for debug
+ # output. Note that these hints should not be used to look up authorities in
+ # security sensitive contexts, such as when looking up attestations to
+ # verify.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
+ # example "qa".
+ },
+ },
+ "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.
+ "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.
+ "windowsDetails": [ # Windows details get their own format because the information format and
+ # model don't match a normal detail. Specifically Windows updates are done as
+ # patches, thus Windows vulnerabilities really are a missing package, rather
+ # than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
+ # vulnerability. Note that there may be multiple hotfixes (and thus
+ # multiple KBs) that mitigate a given vulnerability. Currently any listed
+ # kb's presence is considered a fix.
+ {
+ "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.
+ { # Identifies all appearances of this vulnerability in the package for a
+ # specific distro/location. For example: glibc in
+ # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "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.
+ "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.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # 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.
+ "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.
+ "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.
+ },
+ ],
+ "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
+ "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.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
+ # base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -2016,49 +2072,12 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
# stored in `public_key` (such as the ID or fingerprint for a PGP key, or the
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
- # base-64 encoded.
},
},
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "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.
- "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.
- },
},
],
}</pre>
@@ -2073,7 +2092,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -2089,215 +2108,252 @@
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedNoteNames": [ # Other notes related to this note.
- "A String",
- ],
- "name": "A String", # Output only. The name of the note in the form of
- # `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ "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.
- "distribution": [ # The various channels by which a package is distributed.
+ "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.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
+ # 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.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were
+ "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.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
},
],
- "name": "A String", # Required. Immutable. The name of the package.
},
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and
- # model don't match a normal detail. Specifically Windows updates are done as
- # patches, thus Windows vulnerabilities really are a missing package, rather
- # than a package being at an incorrect version.
- {
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
- # vulnerability. Note that there may be multiple hotfixes (and thus
- # multiple KBs) that mitigate a given vulnerability. Currently any listed
- # kb's presence is considered a fix.
- {
- "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).
- },
- ],
- "name": "A String", # Required. The name of the vulnerability.
- "description": "A String", # The description of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "availabilityImpact": "A String",
- "impactScore": 3.14,
- "exploitabilityScore": 3.14,
- "scope": "A String",
- "integrityImpact": "A String",
- "confidentialityImpact": "A String",
- },
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- "details": [ # All information about the package to specifically identify this
- # vulnerability. One entry per (version range and cpe_uri) the package
- # vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a
- # specific distro/location. For example: glibc in
- # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "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.
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
- # packages etc).
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
- # upstream timestamp from the underlying information source - e.g. Ubuntu
- # security tracker.
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package 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.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # Required. The package being described.
- },
- },
- ],
- "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.
+ "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.
},
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "relatedUrl": [ # URLs associated with this note.
+ "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.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
},
],
- "longDescription": "A String", # A detailed 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
- # the attached occurrences (Attestations). This grouping mechanism also
- # provides a security boundary, since IAM ACLs gate the ability for a principle
- # to attach an occurrence to a given note. It also provides a single point of
- # lookup to find all attached attestation occurrences, even if they don't all
- # live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
- # authority. Because the name of a note acts as its resource reference, it is
- # important to disambiguate the canonical name of the Note (which might be a
- # UUID for security purposes) from "readable" names more suitable for debug
- # output. Note that these hints should not be used to look up authorities in
- # security sensitive contexts, such as when looking up attestations to
- # verify.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
- # example "qa".
- },
- },
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ "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.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "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
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "expectedProducts": [
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "signingKeys": [ # This field contains the public keys that can be used to verify the
+ "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"
+ # "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
+ # 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".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
+ "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.
},
- "build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
+ "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
+ # the attached occurrences (Attestations). This grouping mechanism also
+ # provides a security boundary, since IAM ACLs gate the ability for a principle
+ # to attach an occurrence to a given note. It also provides a single point of
+ # lookup to find all attached attestation occurrences, even if they don't all
+ # live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
+ # authority. Because the name of a note acts as its resource reference, it is
+ # important to disambiguate the canonical name of the Note (which might be a
+ # UUID for security purposes) from "readable" names more suitable for debug
+ # output. Note that these hints should not be used to look up authorities in
+ # security sensitive contexts, such as when looking up attestations to
+ # verify.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
+ # example "qa".
+ },
+ },
+ "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.
+ "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.
+ "windowsDetails": [ # Windows details get their own format because the information format and
+ # model don't match a normal detail. Specifically Windows updates are done as
+ # patches, thus Windows vulnerabilities really are a missing package, rather
+ # than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
+ # vulnerability. Note that there may be multiple hotfixes (and thus
+ # multiple KBs) that mitigate a given vulnerability. Currently any listed
+ # kb's presence is considered a fix.
+ {
+ "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.
+ { # Identifies all appearances of this vulnerability in the package for a
+ # specific distro/location. For example: glibc in
+ # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "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.
+ "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.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # 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.
+ "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.
+ "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.
+ },
+ ],
+ "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
+ "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.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
+ # base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -2310,49 +2366,12 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
# stored in `public_key` (such as the ID or fingerprint for a PGP key, or the
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
- # base-64 encoded.
},
},
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "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.
- "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.
- },
}
updateMask: string, The fields to update.
@@ -2365,215 +2384,252 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
- # a filter in list requests.
- "relatedNoteNames": [ # Other notes related to this note.
- "A String",
- ],
- "name": "A String", # Output only. The name of the note in the form of
- # `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- "package": { # This represents a particular package that is distributed over various # A note describing a package hosted by various package managers.
+ "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.
- "distribution": [ # The various channels by which a package is distributed.
+ "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.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
+ # 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.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "description": "A String", # The distribution channel-specific description of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were
+ "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.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
},
],
- "name": "A String", # Required. Immutable. The name of the package.
},
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and
- # model don't match a normal detail. Specifically Windows updates are done as
- # patches, thus Windows vulnerabilities really are a missing package, rather
- # than a package being at an incorrect version.
- {
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
- # vulnerability. Note that there may be multiple hotfixes (and thus
- # multiple KBs) that mitigate a given vulnerability. Currently any listed
- # kb's presence is considered a fix.
- {
- "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).
- },
- ],
- "name": "A String", # Required. The name of the vulnerability.
- "description": "A String", # The description of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. # The full description of the CVSSv3.
- # For details, see https://www.first.org/cvss/specification-document
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics
- # Represents the intrinsic characteristics of a vulnerability that are
- # constant over time and across user environments.
- "privilegesRequired": "A String",
- "userInteraction": "A String",
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "availabilityImpact": "A String",
- "impactScore": 3.14,
- "exploitabilityScore": 3.14,
- "scope": "A String",
- "integrityImpact": "A String",
- "confidentialityImpact": "A String",
- },
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- "details": [ # All information about the package to specifically identify this
- # vulnerability. One entry per (version range and cpe_uri) the package
- # vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a
- # specific distro/location. For example: glibc in
- # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "cpeUri": "A String", # Required. The CPE URI in
- # [cpe format](https://cpe.mitre.org/specification/) in which the
- # vulnerability manifests. Examples include distro or storage location for
- # vulnerable jar.
- "description": "A String", # A vendor-specific description of this note.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "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.
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
- # obsolete details.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
- # packages etc).
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
- # upstream timestamp from the underlying information source - e.g. Ubuntu
- # security tracker.
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package 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.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
- # versions.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version
- # name.
- "revision": "A String", # The iteration of the package build from the above version.
- },
- "package": "A String", # Required. The package being described.
- },
- },
- ],
- "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.
+ "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.
},
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
- # list requests.
- "relatedUrl": [ # URLs associated with this note.
+ "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.
+ "url": "A String", # Specific URL associated with the resource.
+ "label": "A String", # Label to describe usage of the URL.
},
],
- "longDescription": "A String", # A detailed 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
- # the attached occurrences (Attestations). This grouping mechanism also
- # provides a security boundary, since IAM ACLs gate the ability for a principle
- # to attach an occurrence to a given note. It also provides a single point of
- # lookup to find all attached attestation occurrences, even if they don't all
- # live in the same project.
- "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
- # authority. Because the name of a note acts as its resource reference, it is
- # important to disambiguate the canonical name of the Note (which might be a
- # UUID for security purposes) from "readable" names more suitable for debug
- # output. Note that these hints should not be used to look up authorities in
- # security sensitive contexts, such as when looking up attestations to
- # verify.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
- # example "qa".
- },
- },
- "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ "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.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "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
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "expectedProducts": [
+ "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",
+ "artifactRule": [
+ "A String",
],
},
],
- "signingKeys": [ # This field contains the public keys that can be used to verify the
+ "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"
+ # "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
+ # 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".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "publicKeyValue": "A String", # This field contains the actual public key.
- "keyScheme": "A String", # This field contains the corresponding signature scheme.
- # Eg: "rsassa-pss-sha256".
+ "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.
},
- "build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
+ "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
+ # the attached occurrences (Attestations). This grouping mechanism also
+ # provides a security boundary, since IAM ACLs gate the ability for a principle
+ # to attach an occurrence to a given note. It also provides a single point of
+ # lookup to find all attached attestation occurrences, even if they don't all
+ # live in the same project.
+ "hint": { # This submessage provides human-readable hints about the purpose of the # Hint hints at the purpose of the attestation authority.
+ # authority. Because the name of a note acts as its resource reference, it is
+ # important to disambiguate the canonical name of the Note (which might be a
+ # UUID for security purposes) from "readable" names more suitable for debug
+ # output. Note that these hints should not be used to look up authorities in
+ # security sensitive contexts, such as when looking up attestations to
+ # verify.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for
+ # example "qa".
+ },
+ },
+ "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.
+ "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.
+ "windowsDetails": [ # Windows details get their own format because the information format and
+ # model don't match a normal detail. Specifically Windows updates are done as
+ # patches, thus Windows vulnerabilities really are a missing package, rather
+ # than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this
+ # vulnerability. Note that there may be multiple hotfixes (and thus
+ # multiple KBs) that mitigate a given vulnerability. Currently any listed
+ # kb's presence is considered a fix.
+ {
+ "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.
+ { # Identifies all appearances of this vulnerability in the package for a
+ # specific distro/location. For example: glibc in
+ # cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to
+ # obsolete details.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "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.
+ "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.
+ },
+ "cpeUri": "A String", # Required. The CPE URI in
+ # [cpe format](https://cpe.mitre.org/specification/) in which the
+ # vulnerability manifests. Examples include distro or storage location for
+ # vulnerable jar.
+ "description": "A String", # 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.
+ "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.
+ "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.
+ },
+ ],
+ "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
+ "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.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
+ # `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
+ # base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults
# to PEM encoded public keys.
#
@@ -2586,49 +2642,12 @@
# from `BuildDetails` are base64-decoded into a binary representation in
# signed.bin. OpenSSL can then verify the signature:
# `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in
- # `key_id`.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key
# stored in `public_key` (such as the ID or fingerprint for a PGP key, or the
# CN for a cert), or a reference to an external key (such as a reference to a
# key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is
- # base-64 encoded.
},
},
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
- # relationship. Linked occurrences are derived from this or an
- # equivalent image via:
- # FROM <Basis.resource_url>
- # Or an equivalent reference, e.g. a tag of the resource_url.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the
- # basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
- # representation.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
- "A String",
- ],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
- },
- },
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "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.
- "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.
- },
}</pre>
</div>
@@ -2650,7 +2669,7 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
@@ -2663,36 +2682,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -2710,63 +2733,41 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # 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.
- "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.
- "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.
- },
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -2809,11 +2810,65 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
+ "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
+ "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
@@ -2825,27 +2880,6 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
},
}
@@ -2867,36 +2901,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -2914,63 +2952,41 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # 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.
- "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.
- "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.
- },
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -3013,11 +3029,65 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
+ "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
+ "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
@@ -3029,27 +3099,6 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
}</pre>
</div>
@@ -3070,11 +3119,11 @@
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
- "A String",
+ "A String",
],
}
@@ -3087,9 +3136,9 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
- "A String",
+ "A String",
],
}</pre>
</div>