docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
index 74b8d55..56cc23a 100644
--- a/docs/dyn/containeranalysis_v1beta1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
@@ -123,168 +123,168 @@
The object takes the form of:
{ # Request to create notes in batch.
- "notes": { # Required. The notes to create. Max allowed length is 1000.
+ "notes": { # Required. The notes to create, the key is expected to be the note ID. Max allowed length is 1000.
"a_key": { # A type of analysis that can be done for a resource.
- "relatedNoteNames": [ # Other notes related to this note.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
+ "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ },
+ },
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "label": "A String", # Label to describe usage of the URL.
- "url": "A String", # Specific URL associated with the resource.
+ },
+ "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
+ "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
+ "scope": "A String",
+ "confidentialityImpact": "A String",
+ "privilegesRequired": "A String",
+ "integrityImpact": "A String",
+ "impactScore": 3.14,
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "exploitabilityScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
+ },
+ "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
+ {
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
+ "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
+ },
+ ],
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
},
],
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
+ { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "package": "A String", # Required. The package being described.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
+ },
+ "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # Required. The name of the package where the vulnerability was found.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
},
+ ],
+ "cvssScore": 3.14, # The CVSS score for this vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
+ },
+ "relatedNoteNames": [ # Other notes related to this note.
+ "A String",
+ ],
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "label": "A String", # Label to describe usage of the URL.
+ "url": "A String", # Specific URL associated with the resource.
},
- "longDescription": "A String", # A detailed description of this note.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
- "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ ],
+ "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
},
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
"A String",
],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
- },
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
- },
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
- {
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
- {
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
- "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
- },
- ],
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "description": "A String", # The description of the vulnerability.
- "name": "A String", # Required. The name of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
- "userInteraction": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "availabilityImpact": "A String",
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "confidentialityImpact": "A String",
- "privilegesRequired": "A String",
- "scope": "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
},
- "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "description": "A String", # A vendor-specific description of this note.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
- "package": "A String", # Required. The name of the package where the vulnerability was found.
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
- "package": "A String", # Required. The package being described.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- },
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
- },
- ],
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- },
- "shortDescription": "A String", # A one sentence description of this note.
- "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
- "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- },
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
- "description": "A String", # The distribution channel-specific description of this package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
- },
- ],
- },
- "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ ],
},
+ "shortDescription": "A String", # A one sentence description of this note.
+ "longDescription": "A String", # A detailed description of this note.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
+ "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
+ "description": "A String", # The distribution channel-specific description of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ },
+ ],
+ "name": "A String", # Required. Immutable. The name of the package.
+ },
+ "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
+ "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
+ },
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
+ },
+ "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
+ },
+ },
+ },
},
}
@@ -299,166 +299,166 @@
{ # Response for creating notes in batch.
"notes": [ # The notes that were created.
{ # A type of analysis that can be done for a resource.
- "relatedNoteNames": [ # Other notes related to this note.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
+ "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ },
+ },
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "label": "A String", # Label to describe usage of the URL.
- "url": "A String", # Specific URL associated with the resource.
+ },
+ "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
+ "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
+ "scope": "A String",
+ "confidentialityImpact": "A String",
+ "privilegesRequired": "A String",
+ "integrityImpact": "A String",
+ "impactScore": 3.14,
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "exploitabilityScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
+ },
+ "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
+ {
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
+ "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
+ },
+ ],
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
},
],
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
+ { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "package": "A String", # Required. The package being described.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
+ },
+ "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # Required. The name of the package where the vulnerability was found.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
},
+ ],
+ "cvssScore": 3.14, # The CVSS score for this vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
+ },
+ "relatedNoteNames": [ # Other notes related to this note.
+ "A String",
+ ],
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "label": "A String", # Label to describe usage of the URL.
+ "url": "A String", # Specific URL associated with the resource.
},
- "longDescription": "A String", # A detailed description of this note.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
- "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ ],
+ "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
},
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
"A String",
],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
- },
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
- },
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
- {
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
- {
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
- "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
- },
- ],
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "description": "A String", # The description of the vulnerability.
- "name": "A String", # Required. The name of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
- "userInteraction": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "availabilityImpact": "A String",
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "confidentialityImpact": "A String",
- "privilegesRequired": "A String",
- "scope": "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
},
- "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "description": "A String", # A vendor-specific description of this note.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
- "package": "A String", # Required. The name of the package where the vulnerability was found.
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
- "package": "A String", # Required. The package being described.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- },
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
- },
- ],
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- },
- "shortDescription": "A String", # A one sentence description of this note.
- "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
- "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- },
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
- "description": "A String", # The distribution channel-specific description of this package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
- },
- ],
- },
- "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ ],
},
+ "shortDescription": "A String", # A one sentence description of this note.
+ "longDescription": "A String", # A detailed description of this note.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
+ "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
+ "description": "A String", # The distribution channel-specific description of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ },
+ ],
+ "name": "A String", # Required. Immutable. The name of the package.
+ },
+ "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
+ "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
+ },
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
+ },
+ "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
+ },
+ },
+ },
],
}</pre>
</div>
@@ -478,166 +478,166 @@
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "relatedNoteNames": [ # Other notes related to this note.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
+ "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ },
+ },
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "label": "A String", # Label to describe usage of the URL.
- "url": "A String", # Specific URL associated with the resource.
+ },
+ "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
+ "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
+ "scope": "A String",
+ "confidentialityImpact": "A String",
+ "privilegesRequired": "A String",
+ "integrityImpact": "A String",
+ "impactScore": 3.14,
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "exploitabilityScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
+ },
+ "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
+ {
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
+ "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
+ },
+ ],
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
},
],
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
+ { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "package": "A String", # Required. The package being described.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
+ },
+ "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # Required. The name of the package where the vulnerability was found.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
},
+ ],
+ "cvssScore": 3.14, # The CVSS score for this vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
+ },
+ "relatedNoteNames": [ # Other notes related to this note.
+ "A String",
+ ],
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "label": "A String", # Label to describe usage of the URL.
+ "url": "A String", # Specific URL associated with the resource.
},
- "longDescription": "A String", # A detailed description of this note.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
- "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ ],
+ "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
},
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
"A String",
],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
- },
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
- },
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
- {
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
- {
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
- "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
- },
- ],
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "description": "A String", # The description of the vulnerability.
- "name": "A String", # Required. The name of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
- "userInteraction": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "availabilityImpact": "A String",
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "confidentialityImpact": "A String",
- "privilegesRequired": "A String",
- "scope": "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
},
- "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "description": "A String", # A vendor-specific description of this note.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
- "package": "A String", # Required. The name of the package where the vulnerability was found.
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
- "package": "A String", # Required. The package being described.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- },
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
+ "longDescription": "A String", # A detailed description of this note.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
+ "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
+ "description": "A String", # The distribution channel-specific description of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
},
- ],
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- },
- "shortDescription": "A String", # A one sentence description of this note.
- "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
- "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- },
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
+ },
+ ],
+ "name": "A String", # Required. Immutable. The name of the package.
+ },
+ "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
+ "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
+ },
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
},
- "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
- "description": "A String", # The distribution channel-specific description of this package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
- },
- ],
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
+ },
+ "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
},
- "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- }
+ },
+}
noteId: string, Required. The ID to use for this note.
x__xgafv: string, V1 error format.
@@ -649,166 +649,166 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "relatedNoteNames": [ # Other notes related to this note.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
+ "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ },
+ },
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "label": "A String", # Label to describe usage of the URL.
- "url": "A String", # Specific URL associated with the resource.
+ },
+ "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
+ "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
+ "scope": "A String",
+ "confidentialityImpact": "A String",
+ "privilegesRequired": "A String",
+ "integrityImpact": "A String",
+ "impactScore": 3.14,
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "exploitabilityScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
+ },
+ "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
+ {
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
+ "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
+ },
+ ],
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
},
],
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
+ { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "package": "A String", # Required. The package being described.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
+ },
+ "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # Required. The name of the package where the vulnerability was found.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
},
+ ],
+ "cvssScore": 3.14, # The CVSS score for this vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
+ },
+ "relatedNoteNames": [ # Other notes related to this note.
+ "A String",
+ ],
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "label": "A String", # Label to describe usage of the URL.
+ "url": "A String", # Specific URL associated with the resource.
},
- "longDescription": "A String", # A detailed description of this note.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
- "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ ],
+ "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
},
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
"A String",
],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
- },
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
- },
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
- {
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
- {
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
- "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
- },
- ],
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "description": "A String", # The description of the vulnerability.
- "name": "A String", # Required. The name of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
- "userInteraction": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "availabilityImpact": "A String",
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "confidentialityImpact": "A String",
- "privilegesRequired": "A String",
- "scope": "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
},
- "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "description": "A String", # A vendor-specific description of this note.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
- "package": "A String", # Required. The name of the package where the vulnerability was found.
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
- "package": "A String", # Required. The package being described.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- },
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
+ "longDescription": "A String", # A detailed description of this note.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
+ "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
+ "description": "A String", # The distribution channel-specific description of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
},
- ],
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- },
- "shortDescription": "A String", # A one sentence description of this note.
- "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
- "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- },
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
+ },
+ ],
+ "name": "A String", # Required. Immutable. The name of the package.
+ },
+ "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
+ "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
+ },
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
},
- "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
- "description": "A String", # The distribution channel-specific description of this package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
- },
- ],
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
+ },
+ "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
},
- "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- }</pre>
+ },
+ }</pre>
</div>
<div class="method">
@@ -844,166 +844,166 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "relatedNoteNames": [ # Other notes related to this note.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
+ "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ },
+ },
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "label": "A String", # Label to describe usage of the URL.
- "url": "A String", # Specific URL associated with the resource.
+ },
+ "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
+ "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
+ "scope": "A String",
+ "confidentialityImpact": "A String",
+ "privilegesRequired": "A String",
+ "integrityImpact": "A String",
+ "impactScore": 3.14,
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "exploitabilityScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
+ },
+ "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
+ {
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
+ "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
+ },
+ ],
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
},
],
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
+ { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "package": "A String", # Required. The package being described.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
+ },
+ "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # Required. The name of the package where the vulnerability was found.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
},
+ ],
+ "cvssScore": 3.14, # The CVSS score for this vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
+ },
+ "relatedNoteNames": [ # Other notes related to this note.
+ "A String",
+ ],
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "label": "A String", # Label to describe usage of the URL.
+ "url": "A String", # Specific URL associated with the resource.
},
- "longDescription": "A String", # A detailed description of this note.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
- "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ ],
+ "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
},
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
"A String",
],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
- },
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
- },
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
- {
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
- {
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
- "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
- },
- ],
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "description": "A String", # The description of the vulnerability.
- "name": "A String", # Required. The name of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
- "userInteraction": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "availabilityImpact": "A String",
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "confidentialityImpact": "A String",
- "privilegesRequired": "A String",
- "scope": "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
},
- "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "description": "A String", # A vendor-specific description of this note.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
- "package": "A String", # Required. The name of the package where the vulnerability was found.
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
- "package": "A String", # Required. The package being described.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- },
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
+ "longDescription": "A String", # A detailed description of this note.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
+ "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
+ "description": "A String", # The distribution channel-specific description of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
},
- ],
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- },
- "shortDescription": "A String", # A one sentence description of this note.
- "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
- "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- },
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
+ },
+ ],
+ "name": "A String", # Required. Immutable. The name of the package.
+ },
+ "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
+ "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
+ },
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
},
- "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
- "description": "A String", # The distribution channel-specific description of this package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
- },
- ],
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
+ },
+ "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
},
- "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- }</pre>
+ },
+ }</pre>
</div>
<div class="method">
@@ -1031,22 +1031,21 @@
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
- "A String",
- ],
- "bindingId": "A String",
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
},
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
}</pre>
</div>
@@ -1070,166 +1069,166 @@
{ # Response for listing notes.
"notes": [ # The notes requested.
{ # A type of analysis that can be done for a resource.
- "relatedNoteNames": [ # Other notes related to this note.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
+ "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ },
+ },
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "label": "A String", # Label to describe usage of the URL.
- "url": "A String", # Specific URL associated with the resource.
+ },
+ "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
+ "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
+ "scope": "A String",
+ "confidentialityImpact": "A String",
+ "privilegesRequired": "A String",
+ "integrityImpact": "A String",
+ "impactScore": 3.14,
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "exploitabilityScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
+ },
+ "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
+ {
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
+ "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
+ },
+ ],
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
},
],
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
+ { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "package": "A String", # Required. The package being described.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
+ },
+ "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # Required. The name of the package where the vulnerability was found.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
},
+ ],
+ "cvssScore": 3.14, # The CVSS score for this vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
+ },
+ "relatedNoteNames": [ # Other notes related to this note.
+ "A String",
+ ],
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "label": "A String", # Label to describe usage of the URL.
+ "url": "A String", # Specific URL associated with the resource.
},
- "longDescription": "A String", # A detailed description of this note.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
- "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ ],
+ "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
},
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
"A String",
],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
- },
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
- },
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
- {
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
- {
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
- "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
- },
- ],
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "description": "A String", # The description of the vulnerability.
- "name": "A String", # Required. The name of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
- "userInteraction": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "availabilityImpact": "A String",
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "confidentialityImpact": "A String",
- "privilegesRequired": "A String",
- "scope": "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
},
- "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "description": "A String", # A vendor-specific description of this note.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
- "package": "A String", # Required. The name of the package where the vulnerability was found.
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
- "package": "A String", # Required. The package being described.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- },
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
- },
- ],
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- },
- "shortDescription": "A String", # A one sentence description of this note.
- "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
- "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- },
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
- "A String",
- ],
- },
- "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
- "description": "A String", # The distribution channel-specific description of this package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
- },
- ],
- },
- "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ ],
},
+ "shortDescription": "A String", # A one sentence description of this note.
+ "longDescription": "A String", # A detailed description of this note.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
+ "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
+ "description": "A String", # The distribution channel-specific description of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ },
+ ],
+ "name": "A String", # Required. Immutable. The name of the package.
+ },
+ "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
+ "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
+ },
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ "A String",
+ ],
+ },
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
+ },
+ "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
+ },
+ },
+ },
],
"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.
}</pre>
@@ -1259,166 +1258,166 @@
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "relatedNoteNames": [ # Other notes related to this note.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
+ "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ },
+ },
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "label": "A String", # Label to describe usage of the URL.
- "url": "A String", # Specific URL associated with the resource.
+ },
+ "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
+ "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
+ "scope": "A String",
+ "confidentialityImpact": "A String",
+ "privilegesRequired": "A String",
+ "integrityImpact": "A String",
+ "impactScore": 3.14,
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "exploitabilityScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
+ },
+ "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
+ {
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
+ "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
+ },
+ ],
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
},
],
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
+ { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "package": "A String", # Required. The package being described.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
+ },
+ "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # Required. The name of the package where the vulnerability was found.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
},
+ ],
+ "cvssScore": 3.14, # The CVSS score for this vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
+ },
+ "relatedNoteNames": [ # Other notes related to this note.
+ "A String",
+ ],
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "label": "A String", # Label to describe usage of the URL.
+ "url": "A String", # Specific URL associated with the resource.
},
- "longDescription": "A String", # A detailed description of this note.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
- "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ ],
+ "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
},
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
"A String",
],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
- },
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
- },
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
- {
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
- {
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
- "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
- },
- ],
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "description": "A String", # The description of the vulnerability.
- "name": "A String", # Required. The name of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
- "userInteraction": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "availabilityImpact": "A String",
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "confidentialityImpact": "A String",
- "privilegesRequired": "A String",
- "scope": "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
},
- "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "description": "A String", # A vendor-specific description of this note.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
- "package": "A String", # Required. The name of the package where the vulnerability was found.
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
- "package": "A String", # Required. The package being described.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- },
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
+ "longDescription": "A String", # A detailed description of this note.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
+ "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
+ "description": "A String", # The distribution channel-specific description of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
},
- ],
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- },
- "shortDescription": "A String", # A one sentence description of this note.
- "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
- "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- },
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
+ },
+ ],
+ "name": "A String", # Required. Immutable. The name of the package.
+ },
+ "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
+ "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
+ },
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
},
- "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
- "description": "A String", # The distribution channel-specific description of this package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
- },
- ],
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
+ },
+ "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
},
- "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- }
+ },
+}
updateMask: string, The fields to update.
x__xgafv: string, V1 error format.
@@ -1430,166 +1429,166 @@
An object of the form:
{ # A type of analysis that can be done for a resource.
- "relatedNoteNames": [ # Other notes related to this note.
+ "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
+ "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
+ "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ },
+ },
+ "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
+ "resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
- "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
- "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
- "relatedUrl": [ # URLs associated with this note.
- { # Metadata for any related URL information.
- "label": "A String", # Label to describe usage of the URL.
- "url": "A String", # Specific URL associated with the resource.
+ },
+ "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
+ "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
+ "scope": "A String",
+ "confidentialityImpact": "A String",
+ "privilegesRequired": "A String",
+ "integrityImpact": "A String",
+ "impactScore": 3.14,
+ "baseScore": 3.14, # The base score is a function of the base metric scores.
+ "exploitabilityScore": 3.14,
+ "attackComplexity": "A String",
+ "availabilityImpact": "A String",
+ "userInteraction": "A String",
+ "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
+ },
+ "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
+ {
+ "name": "A String", # Required. The name of the vulnerability.
+ "description": "A String", # The description of the vulnerability.
+ "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
+ {
+ "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
+ "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
+ },
+ ],
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
},
],
- "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
- "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
- "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
- "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
- "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
- "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
- "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
- "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
+ { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
+ "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
+ "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "package": "A String", # Required. The package being described.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
+ },
+ "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
+ "description": "A String", # A vendor-specific description of this note.
+ "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
+ "package": "A String", # Required. The name of the package where the vulnerability was found.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
+ "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
+ "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
+ },
},
+ ],
+ "cvssScore": 3.14, # The CVSS score for this vulnerability.
+ "severity": "A String", # Note provider assigned impact of the vulnerability.
+ },
+ "relatedNoteNames": [ # Other notes related to this note.
+ "A String",
+ ],
+ "relatedUrl": [ # URLs associated with this note.
+ { # Metadata for any related URL information.
+ "label": "A String", # Label to describe usage of the URL.
+ "url": "A String", # Specific URL associated with the resource.
},
- "longDescription": "A String", # A detailed description of this note.
- "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
- "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
- "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
+ ],
+ "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
+ "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
+ "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
},
- },
- "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
- "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
- "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
- "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
+ ],
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
"A String",
],
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
- "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
},
- },
- "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
- "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
- },
- "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
- "cvssScore": 3.14, # The CVSS score for this vulnerability.
- "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
- {
- "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
- {
- "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
- "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
- },
- ],
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "description": "A String", # The description of the vulnerability.
- "name": "A String", # Required. The name of the vulnerability.
- },
- ],
- "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3.
- "userInteraction": "A String",
- "integrityImpact": "A String",
- "exploitabilityScore": 3.14,
- "impactScore": 3.14,
- "availabilityImpact": "A String",
- "attackComplexity": "A String",
- "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
- "baseScore": 3.14, # The base score is a function of the base metric scores.
- "confidentialityImpact": "A String",
- "privilegesRequired": "A String",
- "scope": "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
},
- "details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
- { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
- "description": "A String", # A vendor-specific description of this note.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
- "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
- "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
- "package": "A String", # Required. The name of the package where the vulnerability was found.
- "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
- "package": "A String", # Required. The package being described.
- "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
- "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- },
- "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
+ ],
+ },
+ "shortDescription": "A String", # A one sentence description of this note.
+ "longDescription": "A String", # A detailed description of this note.
+ "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
+ "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+ "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
+ "distribution": [ # The various channels by which a package is distributed.
+ { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
+ "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
+ "maintainer": "A String", # A freeform string denoting the maintainer of this package.
+ "url": "A String", # The distribution channel-specific homepage for this package.
+ "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
+ "description": "A String", # The distribution channel-specific description of this package.
+ "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
+ "revision": "A String", # The iteration of the package build from the above version.
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
+ "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
},
- ],
- "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
- "severity": "A String", # Note provider assigned impact of the vulnerability.
- },
- "shortDescription": "A String", # A one sentence description of this note.
- "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
- "expectedProducts": [
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
- { # Defines an object to declare an in-toto artifact rule
- "artifactRule": [
- "A String",
- ],
- },
- ],
- "expectedCommand": [ # This field contains the expected command used to perform the step.
- "A String",
- ],
- "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
- { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
- "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
- "keyId": "A String", # key_id is an identifier for the signing key.
- "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
- "publicKeyValue": "A String", # This field contains the actual public key.
- },
- ],
- "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
- "stepName": "A String", # This field identifies the name of the step in the supply chain.
- },
- "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
- "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
- "resourceUri": [ # Required. Resource URI for the artifact being deployed.
+ },
+ ],
+ "name": "A String", # Required. Immutable. The name of the package.
+ },
+ "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
+ "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
+ "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
+ "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
+ },
+ "baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
+ "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
+ "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
+ "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
},
- "package": { # This represents a particular package that is distributed over various channels. E.g., glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
- "name": "A String", # Required. Immutable. The name of the package.
- "distribution": [ # The various channels by which a package is distributed.
- { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
- "description": "A String", # The distribution channel-specific description of this package.
- "maintainer": "A String", # A freeform string denoting the maintainer of this package.
- "url": "A String", # The distribution channel-specific homepage for this package.
- "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
- "name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- "revision": "A String", # The iteration of the package build from the above version.
- "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
- },
- "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
- "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
- },
- ],
+ "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
+ },
+ "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
+ "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
+ "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
+ "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
+ "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
+ "publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
+ "keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
},
- "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
- }</pre>
+ },
+ }</pre>
</div>
<div class="method">
@@ -1604,22 +1603,21 @@
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
- "A String",
- ],
- "bindingId": "A String",
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
},
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
},
}
@@ -1633,22 +1631,21 @@
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
- "A String",
- ],
- "bindingId": "A String",
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
},
"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
+ "A String",
+ ],
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
}</pre>
</div>