1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="containeranalysis_v1alpha1.html">Container Analysis API</a> . <a href="containeranalysis_v1alpha1.projects.html">projects</a> . <a href="containeranalysis_v1alpha1.projects.notes.html">notes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="containeranalysis_v1alpha1.projects.notes.occurrences.html">occurrences()</a></code> 79</p> 80<p class="firstline">Returns the occurrences Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, name=None, noteId=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a new `Note`.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes the given `Note` from the system.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Returns the requested `Note`.</p> 94<p class="toc_element"> 95 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes</p> 97<p class="toc_element"> 98 <code><a href="#list">list(parent, filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Lists all `Notes` for a given project.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</p> 103<p class="toc_element"> 104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates an existing `Note`.</p> 106<p class="toc_element"> 107 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> 108<p class="firstline">Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes</p> 109<p class="toc_element"> 110 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> 111<p class="firstline">Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`</p> 112<h3>Method Details</h3> 113<div class="method"> 114 <code class="details" id="close">close()</code> 115 <pre>Close httplib2 connections.</pre> 116</div> 117 118<div class="method"> 119 <code class="details" id="create">create(parent, body=None, name=None, noteId=None, x__xgafv=None)</code> 120 <pre>Creates a new `Note`. 121 122Args: 123 parent: string, This field contains the project Id for example: "projects/{project_id} (required) 124 body: object, The request body. 125 The object takes the form of: 126 127{ # Provides a detailed description of a `Note`. 128 "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `AttestationAuthority` for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. # A note describing an attestation role. 129 "hint": { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. 130 "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". 131 }, 132 }, 133 "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. 134 "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. 135 "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests. 136 "v2Blob": [ # The ordered list of v2 blobs that represent a given image. 137 "A String", 138 ], 139 "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests. 140 }, 141 "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. 142 }, 143 "buildType": { # Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build. 144 "builderVersion": "A String", # Version of the builder which produced this Note. 145 "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. 146 "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). 147 "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` 148 "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` 149 "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. 150 }, 151 }, 152 "compliance": { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check. 153 "cisBenchmark": { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future. 154 "profileLevel": 42, # The profile level of this CIS benchmark check. 155 "severity": "A String", # The severity level of this CIS benchmark check. 156 }, 157 "description": "A String", # A description about this compliance check. 158 "rationale": "A String", # A rationale for the existence of this compliance check. 159 "remediation": "A String", # A description of remediation steps if the compliance check fails. 160 "scanInstructions": "A String", # Serialized scan instructions with a predefined format. 161 "title": "A String", # The title that identifies this compliance check. 162 "version": [ # The OS and config versions the benchmark applies to. 163 { # Describes the CIS benchmark version that is applicable to a given OS and os version. 164 "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. 165 "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. 166 }, 167 ], 168 }, 169 "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. 170 "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. 171 "resourceUri": [ # Resource URI for the artifact being deployed. 172 "A String", 173 ], 174 }, 175 "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. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. # A note describing a provider/analysis type. 176 "analysisKind": "A String", # The kind of analysis that is handled by this discovery. 177 }, 178 "dsseAttestation": { # A note describing an attestation # A note describing a dsse attestation note. 179 "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. # DSSEHint hints at the purpose of the attestation authority. 180 "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod". 181 }, 182 }, 183 "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. 184 "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. 185 "longDescription": "A String", # A detailed description of this `Note`. 186 "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" 187 "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. 188 "distribution": [ # The various channels by which a package is distributed. 189 { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror 190 "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built 191 "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. 192 "description": "A String", # The distribution channel-specific description of this package. 193 "latestVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel. 194 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 195 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 196 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 197 "name": "A String", # The main part of the version name. 198 "revision": "A String", # The iteration of the package build from the above version. 199 }, 200 "maintainer": "A String", # A freeform string denoting the maintainer of this package. 201 "url": "A String", # The distribution channel-specific homepage for this package. 202 }, 203 ], 204 "name": "A String", # The name of the package. 205 }, 206 "relatedUrl": [ # URLs associated with this note 207 { # Metadata for any related URL information 208 "label": "A String", # Label to describe usage of the URL 209 "url": "A String", # Specific URL to associate with the note 210 }, 211 ], 212 "sbom": { # DocumentNote represents an SPDX Document Creation Infromation section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing a software bill of materials. 213 "dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata") 214 "spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file 215 }, 216 "shortDescription": "A String", # A one sentence description of this `Note`. 217 "spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File. 218 "checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package 219 "A String", 220 ], 221 "fileType": "A String", # This field provides information about the type of file identified 222 "title": "A String", # Identify the full path and filename that corresponds to the file information in this section 223 }, 224 "spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package. 225 "analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document 226 "attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts 227 "checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file 228 "copyright": "A String", # Identify the copyright holders of the package, as well as any dates present 229 "detailedDescription": "A String", # A more detailed description of the package 230 "downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created 231 "externalRefs": [ # ExternalRef 232 { # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 233 "category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 234 "comment": "A String", # Human-readable information about the purpose and target of the reference 235 "locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location 236 "type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category) 237 }, 238 ], 239 "filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found 240 "A String", 241 ], 242 "homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page 243 "licenseDeclared": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # List the licenses that have been declared by the authors of the package 244 "comments": "A String", # Comments 245 "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ 246 }, 247 "originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came 248 "packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc. 249 "summaryDescription": "A String", # A short description of the package 250 "supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file 251 "title": "A String", # Identify the full name of the package as given by the Package Originator 252 "verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file 253 "version": "A String", # Identify the version of the package 254 }, 255 "spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing a relationship between SPDX elements. 256 "type": "A String", # The type of relationship between the source and target SPDX elements 257 }, 258 "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. 259 "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade. 260 "distributions": [ # Metadata about the upgrade for each specific operating system. 261 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. 262 "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. 263 "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. 264 "cve": [ # The cve that would be resolved by this upgrade. 265 "A String", 266 ], 267 "severity": "A String", # The severity as specified by the upstream operating system. 268 }, 269 ], 270 "package": "A String", # Required - The package this Upgrade is for. 271 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form. 272 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 273 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 274 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 275 "name": "A String", # The main part of the version name. 276 "revision": "A String", # The iteration of the package build from the above version. 277 }, 278 }, 279 "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. 280 "cvssScore": 3.14, # The CVSS score for this Vulnerability. 281 "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. 282 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 283 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 284 "description": "A String", # A vendor-specific description of this note. 285 "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. 286 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 287 "package": "A String", # The package being described. 288 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests. 289 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 290 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 291 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 292 "name": "A String", # The main part of the version name. 293 "revision": "A String", # The iteration of the package build from the above version. 294 }, 295 }, 296 "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. 297 "maxAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists. 298 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 299 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 300 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 301 "name": "A String", # The main part of the version name. 302 "revision": "A String", # The iteration of the package build from the above version. 303 }, 304 "minAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists. 305 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 306 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 307 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 308 "name": "A String", # The main part of the version name. 309 "revision": "A String", # The iteration of the package build from the above version. 310 }, 311 "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. 312 "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) 313 "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. 314 "source": "A String", # The source from which the information in this Detail was obtained. 315 "vendor": "A String", # The vendor of the product. e.g. "google" 316 }, 317 ], 318 "severity": "A String", # Note provider assigned impact of the vulnerability 319 }, 320} 321 322 name: string, The name of the project. Should be of the form "providers/{provider_id}". @Deprecated 323 noteId: string, The ID to use for this note. 324 x__xgafv: string, V1 error format. 325 Allowed values 326 1 - v1 error format 327 2 - v2 error format 328 329Returns: 330 An object of the form: 331 332 { # Provides a detailed description of a `Note`. 333 "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `AttestationAuthority` for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. # A note describing an attestation role. 334 "hint": { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. 335 "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". 336 }, 337 }, 338 "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. 339 "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. 340 "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests. 341 "v2Blob": [ # The ordered list of v2 blobs that represent a given image. 342 "A String", 343 ], 344 "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests. 345 }, 346 "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. 347 }, 348 "buildType": { # Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build. 349 "builderVersion": "A String", # Version of the builder which produced this Note. 350 "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. 351 "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). 352 "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` 353 "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` 354 "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. 355 }, 356 }, 357 "compliance": { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check. 358 "cisBenchmark": { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future. 359 "profileLevel": 42, # The profile level of this CIS benchmark check. 360 "severity": "A String", # The severity level of this CIS benchmark check. 361 }, 362 "description": "A String", # A description about this compliance check. 363 "rationale": "A String", # A rationale for the existence of this compliance check. 364 "remediation": "A String", # A description of remediation steps if the compliance check fails. 365 "scanInstructions": "A String", # Serialized scan instructions with a predefined format. 366 "title": "A String", # The title that identifies this compliance check. 367 "version": [ # The OS and config versions the benchmark applies to. 368 { # Describes the CIS benchmark version that is applicable to a given OS and os version. 369 "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. 370 "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. 371 }, 372 ], 373 }, 374 "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. 375 "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. 376 "resourceUri": [ # Resource URI for the artifact being deployed. 377 "A String", 378 ], 379 }, 380 "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. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. # A note describing a provider/analysis type. 381 "analysisKind": "A String", # The kind of analysis that is handled by this discovery. 382 }, 383 "dsseAttestation": { # A note describing an attestation # A note describing a dsse attestation note. 384 "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. # DSSEHint hints at the purpose of the attestation authority. 385 "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod". 386 }, 387 }, 388 "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. 389 "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. 390 "longDescription": "A String", # A detailed description of this `Note`. 391 "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" 392 "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. 393 "distribution": [ # The various channels by which a package is distributed. 394 { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror 395 "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built 396 "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. 397 "description": "A String", # The distribution channel-specific description of this package. 398 "latestVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel. 399 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 400 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 401 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 402 "name": "A String", # The main part of the version name. 403 "revision": "A String", # The iteration of the package build from the above version. 404 }, 405 "maintainer": "A String", # A freeform string denoting the maintainer of this package. 406 "url": "A String", # The distribution channel-specific homepage for this package. 407 }, 408 ], 409 "name": "A String", # The name of the package. 410 }, 411 "relatedUrl": [ # URLs associated with this note 412 { # Metadata for any related URL information 413 "label": "A String", # Label to describe usage of the URL 414 "url": "A String", # Specific URL to associate with the note 415 }, 416 ], 417 "sbom": { # DocumentNote represents an SPDX Document Creation Infromation section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing a software bill of materials. 418 "dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata") 419 "spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file 420 }, 421 "shortDescription": "A String", # A one sentence description of this `Note`. 422 "spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File. 423 "checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package 424 "A String", 425 ], 426 "fileType": "A String", # This field provides information about the type of file identified 427 "title": "A String", # Identify the full path and filename that corresponds to the file information in this section 428 }, 429 "spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package. 430 "analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document 431 "attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts 432 "checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file 433 "copyright": "A String", # Identify the copyright holders of the package, as well as any dates present 434 "detailedDescription": "A String", # A more detailed description of the package 435 "downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created 436 "externalRefs": [ # ExternalRef 437 { # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 438 "category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 439 "comment": "A String", # Human-readable information about the purpose and target of the reference 440 "locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location 441 "type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category) 442 }, 443 ], 444 "filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found 445 "A String", 446 ], 447 "homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page 448 "licenseDeclared": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # List the licenses that have been declared by the authors of the package 449 "comments": "A String", # Comments 450 "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ 451 }, 452 "originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came 453 "packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc. 454 "summaryDescription": "A String", # A short description of the package 455 "supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file 456 "title": "A String", # Identify the full name of the package as given by the Package Originator 457 "verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file 458 "version": "A String", # Identify the version of the package 459 }, 460 "spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing a relationship between SPDX elements. 461 "type": "A String", # The type of relationship between the source and target SPDX elements 462 }, 463 "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. 464 "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade. 465 "distributions": [ # Metadata about the upgrade for each specific operating system. 466 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. 467 "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. 468 "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. 469 "cve": [ # The cve that would be resolved by this upgrade. 470 "A String", 471 ], 472 "severity": "A String", # The severity as specified by the upstream operating system. 473 }, 474 ], 475 "package": "A String", # Required - The package this Upgrade is for. 476 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form. 477 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 478 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 479 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 480 "name": "A String", # The main part of the version name. 481 "revision": "A String", # The iteration of the package build from the above version. 482 }, 483 }, 484 "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. 485 "cvssScore": 3.14, # The CVSS score for this Vulnerability. 486 "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. 487 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 488 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 489 "description": "A String", # A vendor-specific description of this note. 490 "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. 491 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 492 "package": "A String", # The package being described. 493 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests. 494 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 495 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 496 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 497 "name": "A String", # The main part of the version name. 498 "revision": "A String", # The iteration of the package build from the above version. 499 }, 500 }, 501 "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. 502 "maxAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists. 503 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 504 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 505 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 506 "name": "A String", # The main part of the version name. 507 "revision": "A String", # The iteration of the package build from the above version. 508 }, 509 "minAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists. 510 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 511 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 512 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 513 "name": "A String", # The main part of the version name. 514 "revision": "A String", # The iteration of the package build from the above version. 515 }, 516 "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. 517 "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) 518 "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. 519 "source": "A String", # The source from which the information in this Detail was obtained. 520 "vendor": "A String", # The vendor of the product. e.g. "google" 521 }, 522 ], 523 "severity": "A String", # Note provider assigned impact of the vulnerability 524 }, 525}</pre> 526</div> 527 528<div class="method"> 529 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 530 <pre>Deletes the given `Note` from the system. 531 532Args: 533 name: string, The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}" (required) 534 x__xgafv: string, V1 error format. 535 Allowed values 536 1 - v1 error format 537 2 - v2 error format 538 539Returns: 540 An object of the form: 541 542 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 543}</pre> 544</div> 545 546<div class="method"> 547 <code class="details" id="get">get(name, x__xgafv=None)</code> 548 <pre>Returns the requested `Note`. 549 550Args: 551 name: string, The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}" (required) 552 x__xgafv: string, V1 error format. 553 Allowed values 554 1 - v1 error format 555 2 - v2 error format 556 557Returns: 558 An object of the form: 559 560 { # Provides a detailed description of a `Note`. 561 "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `AttestationAuthority` for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. # A note describing an attestation role. 562 "hint": { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. 563 "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". 564 }, 565 }, 566 "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. 567 "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. 568 "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests. 569 "v2Blob": [ # The ordered list of v2 blobs that represent a given image. 570 "A String", 571 ], 572 "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests. 573 }, 574 "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. 575 }, 576 "buildType": { # Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build. 577 "builderVersion": "A String", # Version of the builder which produced this Note. 578 "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. 579 "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). 580 "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` 581 "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` 582 "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. 583 }, 584 }, 585 "compliance": { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check. 586 "cisBenchmark": { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future. 587 "profileLevel": 42, # The profile level of this CIS benchmark check. 588 "severity": "A String", # The severity level of this CIS benchmark check. 589 }, 590 "description": "A String", # A description about this compliance check. 591 "rationale": "A String", # A rationale for the existence of this compliance check. 592 "remediation": "A String", # A description of remediation steps if the compliance check fails. 593 "scanInstructions": "A String", # Serialized scan instructions with a predefined format. 594 "title": "A String", # The title that identifies this compliance check. 595 "version": [ # The OS and config versions the benchmark applies to. 596 { # Describes the CIS benchmark version that is applicable to a given OS and os version. 597 "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. 598 "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. 599 }, 600 ], 601 }, 602 "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. 603 "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. 604 "resourceUri": [ # Resource URI for the artifact being deployed. 605 "A String", 606 ], 607 }, 608 "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. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. # A note describing a provider/analysis type. 609 "analysisKind": "A String", # The kind of analysis that is handled by this discovery. 610 }, 611 "dsseAttestation": { # A note describing an attestation # A note describing a dsse attestation note. 612 "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. # DSSEHint hints at the purpose of the attestation authority. 613 "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod". 614 }, 615 }, 616 "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. 617 "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. 618 "longDescription": "A String", # A detailed description of this `Note`. 619 "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" 620 "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. 621 "distribution": [ # The various channels by which a package is distributed. 622 { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror 623 "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built 624 "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. 625 "description": "A String", # The distribution channel-specific description of this package. 626 "latestVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel. 627 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 628 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 629 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 630 "name": "A String", # The main part of the version name. 631 "revision": "A String", # The iteration of the package build from the above version. 632 }, 633 "maintainer": "A String", # A freeform string denoting the maintainer of this package. 634 "url": "A String", # The distribution channel-specific homepage for this package. 635 }, 636 ], 637 "name": "A String", # The name of the package. 638 }, 639 "relatedUrl": [ # URLs associated with this note 640 { # Metadata for any related URL information 641 "label": "A String", # Label to describe usage of the URL 642 "url": "A String", # Specific URL to associate with the note 643 }, 644 ], 645 "sbom": { # DocumentNote represents an SPDX Document Creation Infromation section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing a software bill of materials. 646 "dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata") 647 "spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file 648 }, 649 "shortDescription": "A String", # A one sentence description of this `Note`. 650 "spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File. 651 "checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package 652 "A String", 653 ], 654 "fileType": "A String", # This field provides information about the type of file identified 655 "title": "A String", # Identify the full path and filename that corresponds to the file information in this section 656 }, 657 "spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package. 658 "analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document 659 "attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts 660 "checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file 661 "copyright": "A String", # Identify the copyright holders of the package, as well as any dates present 662 "detailedDescription": "A String", # A more detailed description of the package 663 "downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created 664 "externalRefs": [ # ExternalRef 665 { # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 666 "category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 667 "comment": "A String", # Human-readable information about the purpose and target of the reference 668 "locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location 669 "type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category) 670 }, 671 ], 672 "filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found 673 "A String", 674 ], 675 "homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page 676 "licenseDeclared": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # List the licenses that have been declared by the authors of the package 677 "comments": "A String", # Comments 678 "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ 679 }, 680 "originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came 681 "packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc. 682 "summaryDescription": "A String", # A short description of the package 683 "supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file 684 "title": "A String", # Identify the full name of the package as given by the Package Originator 685 "verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file 686 "version": "A String", # Identify the version of the package 687 }, 688 "spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing a relationship between SPDX elements. 689 "type": "A String", # The type of relationship between the source and target SPDX elements 690 }, 691 "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. 692 "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade. 693 "distributions": [ # Metadata about the upgrade for each specific operating system. 694 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. 695 "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. 696 "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. 697 "cve": [ # The cve that would be resolved by this upgrade. 698 "A String", 699 ], 700 "severity": "A String", # The severity as specified by the upstream operating system. 701 }, 702 ], 703 "package": "A String", # Required - The package this Upgrade is for. 704 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form. 705 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 706 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 707 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 708 "name": "A String", # The main part of the version name. 709 "revision": "A String", # The iteration of the package build from the above version. 710 }, 711 }, 712 "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. 713 "cvssScore": 3.14, # The CVSS score for this Vulnerability. 714 "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. 715 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 716 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 717 "description": "A String", # A vendor-specific description of this note. 718 "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. 719 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 720 "package": "A String", # The package being described. 721 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests. 722 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 723 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 724 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 725 "name": "A String", # The main part of the version name. 726 "revision": "A String", # The iteration of the package build from the above version. 727 }, 728 }, 729 "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. 730 "maxAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists. 731 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 732 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 733 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 734 "name": "A String", # The main part of the version name. 735 "revision": "A String", # The iteration of the package build from the above version. 736 }, 737 "minAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists. 738 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 739 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 740 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 741 "name": "A String", # The main part of the version name. 742 "revision": "A String", # The iteration of the package build from the above version. 743 }, 744 "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. 745 "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) 746 "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. 747 "source": "A String", # The source from which the information in this Detail was obtained. 748 "vendor": "A String", # The vendor of the product. e.g. "google" 749 }, 750 ], 751 "severity": "A String", # Note provider assigned impact of the vulnerability 752 }, 753}</pre> 754</div> 755 756<div class="method"> 757 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> 758 <pre>Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes 759 760Args: 761 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) 762 body: object, The request body. 763 The object takes the form of: 764 765{ # Request message for `GetIamPolicy` method. 766 "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. 767 "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 768 }, 769} 770 771 x__xgafv: string, V1 error format. 772 Allowed values 773 1 - v1 error format 774 2 - v2 error format 775 776Returns: 777 An object of the form: 778 779 { # 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`, or principals, to a single `role`. Principals 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/). 780 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 781 { # Associates `members`, or principals, with a `role`. 782 "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 principals 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). 783 "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. 784 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 785 "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. 786 "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. 787 }, 788 "members": [ # Specifies the principals 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`. 789 "A String", 790 ], 791 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 792 }, 793 ], 794 "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. 795 "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). 796}</pre> 797</div> 798 799<div class="method"> 800 <code class="details" id="list">list(parent, filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 801 <pre>Lists all `Notes` for a given project. 802 803Args: 804 parent: string, This field contains the project Id for example: "projects/{PROJECT_ID}". (required) 805 filter: string, The filter expression. 806 name: string, The name field will contain the project Id for example: "providers/{provider_id} @Deprecated 807 pageSize: integer, Number of notes to return in the list. 808 pageToken: string, Token to provide to skip to a particular spot in the list. 809 x__xgafv: string, V1 error format. 810 Allowed values 811 1 - v1 error format 812 2 - v2 error format 813 814Returns: 815 An object of the form: 816 817 { # Response including listed notes. 818 "nextPageToken": "A String", # The next pagination token in the list response. It should be used as page_token for the following request. An empty value means no more result. 819 "notes": [ # The occurrences requested 820 { # Provides a detailed description of a `Note`. 821 "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `AttestationAuthority` for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. # A note describing an attestation role. 822 "hint": { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. 823 "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". 824 }, 825 }, 826 "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. 827 "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. 828 "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests. 829 "v2Blob": [ # The ordered list of v2 blobs that represent a given image. 830 "A String", 831 ], 832 "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests. 833 }, 834 "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. 835 }, 836 "buildType": { # Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build. 837 "builderVersion": "A String", # Version of the builder which produced this Note. 838 "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. 839 "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). 840 "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` 841 "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` 842 "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. 843 }, 844 }, 845 "compliance": { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check. 846 "cisBenchmark": { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future. 847 "profileLevel": 42, # The profile level of this CIS benchmark check. 848 "severity": "A String", # The severity level of this CIS benchmark check. 849 }, 850 "description": "A String", # A description about this compliance check. 851 "rationale": "A String", # A rationale for the existence of this compliance check. 852 "remediation": "A String", # A description of remediation steps if the compliance check fails. 853 "scanInstructions": "A String", # Serialized scan instructions with a predefined format. 854 "title": "A String", # The title that identifies this compliance check. 855 "version": [ # The OS and config versions the benchmark applies to. 856 { # Describes the CIS benchmark version that is applicable to a given OS and os version. 857 "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. 858 "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. 859 }, 860 ], 861 }, 862 "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. 863 "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. 864 "resourceUri": [ # Resource URI for the artifact being deployed. 865 "A String", 866 ], 867 }, 868 "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. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. # A note describing a provider/analysis type. 869 "analysisKind": "A String", # The kind of analysis that is handled by this discovery. 870 }, 871 "dsseAttestation": { # A note describing an attestation # A note describing a dsse attestation note. 872 "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. # DSSEHint hints at the purpose of the attestation authority. 873 "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod". 874 }, 875 }, 876 "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. 877 "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. 878 "longDescription": "A String", # A detailed description of this `Note`. 879 "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" 880 "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. 881 "distribution": [ # The various channels by which a package is distributed. 882 { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror 883 "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built 884 "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. 885 "description": "A String", # The distribution channel-specific description of this package. 886 "latestVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel. 887 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 888 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 889 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 890 "name": "A String", # The main part of the version name. 891 "revision": "A String", # The iteration of the package build from the above version. 892 }, 893 "maintainer": "A String", # A freeform string denoting the maintainer of this package. 894 "url": "A String", # The distribution channel-specific homepage for this package. 895 }, 896 ], 897 "name": "A String", # The name of the package. 898 }, 899 "relatedUrl": [ # URLs associated with this note 900 { # Metadata for any related URL information 901 "label": "A String", # Label to describe usage of the URL 902 "url": "A String", # Specific URL to associate with the note 903 }, 904 ], 905 "sbom": { # DocumentNote represents an SPDX Document Creation Infromation section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing a software bill of materials. 906 "dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata") 907 "spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file 908 }, 909 "shortDescription": "A String", # A one sentence description of this `Note`. 910 "spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File. 911 "checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package 912 "A String", 913 ], 914 "fileType": "A String", # This field provides information about the type of file identified 915 "title": "A String", # Identify the full path and filename that corresponds to the file information in this section 916 }, 917 "spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package. 918 "analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document 919 "attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts 920 "checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file 921 "copyright": "A String", # Identify the copyright holders of the package, as well as any dates present 922 "detailedDescription": "A String", # A more detailed description of the package 923 "downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created 924 "externalRefs": [ # ExternalRef 925 { # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 926 "category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 927 "comment": "A String", # Human-readable information about the purpose and target of the reference 928 "locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location 929 "type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category) 930 }, 931 ], 932 "filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found 933 "A String", 934 ], 935 "homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page 936 "licenseDeclared": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # List the licenses that have been declared by the authors of the package 937 "comments": "A String", # Comments 938 "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ 939 }, 940 "originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came 941 "packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc. 942 "summaryDescription": "A String", # A short description of the package 943 "supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file 944 "title": "A String", # Identify the full name of the package as given by the Package Originator 945 "verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file 946 "version": "A String", # Identify the version of the package 947 }, 948 "spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing a relationship between SPDX elements. 949 "type": "A String", # The type of relationship between the source and target SPDX elements 950 }, 951 "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. 952 "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade. 953 "distributions": [ # Metadata about the upgrade for each specific operating system. 954 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. 955 "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. 956 "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. 957 "cve": [ # The cve that would be resolved by this upgrade. 958 "A String", 959 ], 960 "severity": "A String", # The severity as specified by the upstream operating system. 961 }, 962 ], 963 "package": "A String", # Required - The package this Upgrade is for. 964 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form. 965 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 966 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 967 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 968 "name": "A String", # The main part of the version name. 969 "revision": "A String", # The iteration of the package build from the above version. 970 }, 971 }, 972 "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. 973 "cvssScore": 3.14, # The CVSS score for this Vulnerability. 974 "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. 975 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 976 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 977 "description": "A String", # A vendor-specific description of this note. 978 "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. 979 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 980 "package": "A String", # The package being described. 981 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests. 982 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 983 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 984 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 985 "name": "A String", # The main part of the version name. 986 "revision": "A String", # The iteration of the package build from the above version. 987 }, 988 }, 989 "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. 990 "maxAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists. 991 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 992 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 993 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 994 "name": "A String", # The main part of the version name. 995 "revision": "A String", # The iteration of the package build from the above version. 996 }, 997 "minAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists. 998 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 999 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1000 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1001 "name": "A String", # The main part of the version name. 1002 "revision": "A String", # The iteration of the package build from the above version. 1003 }, 1004 "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. 1005 "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) 1006 "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. 1007 "source": "A String", # The source from which the information in this Detail was obtained. 1008 "vendor": "A String", # The vendor of the product. e.g. "google" 1009 }, 1010 ], 1011 "severity": "A String", # Note provider assigned impact of the vulnerability 1012 }, 1013 }, 1014 ], 1015}</pre> 1016</div> 1017 1018<div class="method"> 1019 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1020 <pre>Retrieves the next page of results. 1021 1022Args: 1023 previous_request: The request for the previous page. (required) 1024 previous_response: The response from the request for the previous page. (required) 1025 1026Returns: 1027 A request object that you can call 'execute()' on to request the next 1028 page. Returns None if there are no more items in the collection. 1029 </pre> 1030</div> 1031 1032<div class="method"> 1033 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 1034 <pre>Updates an existing `Note`. 1035 1036Args: 1037 name: string, The name of the note. Should be of the form "projects/{provider_id}/notes/{note_id}". (required) 1038 body: object, The request body. 1039 The object takes the form of: 1040 1041{ # Provides a detailed description of a `Note`. 1042 "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `AttestationAuthority` for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. # A note describing an attestation role. 1043 "hint": { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. 1044 "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". 1045 }, 1046 }, 1047 "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. 1048 "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. 1049 "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests. 1050 "v2Blob": [ # The ordered list of v2 blobs that represent a given image. 1051 "A String", 1052 ], 1053 "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests. 1054 }, 1055 "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. 1056 }, 1057 "buildType": { # Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build. 1058 "builderVersion": "A String", # Version of the builder which produced this Note. 1059 "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. 1060 "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). 1061 "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` 1062 "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` 1063 "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. 1064 }, 1065 }, 1066 "compliance": { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check. 1067 "cisBenchmark": { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future. 1068 "profileLevel": 42, # The profile level of this CIS benchmark check. 1069 "severity": "A String", # The severity level of this CIS benchmark check. 1070 }, 1071 "description": "A String", # A description about this compliance check. 1072 "rationale": "A String", # A rationale for the existence of this compliance check. 1073 "remediation": "A String", # A description of remediation steps if the compliance check fails. 1074 "scanInstructions": "A String", # Serialized scan instructions with a predefined format. 1075 "title": "A String", # The title that identifies this compliance check. 1076 "version": [ # The OS and config versions the benchmark applies to. 1077 { # Describes the CIS benchmark version that is applicable to a given OS and os version. 1078 "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. 1079 "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. 1080 }, 1081 ], 1082 }, 1083 "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. 1084 "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. 1085 "resourceUri": [ # Resource URI for the artifact being deployed. 1086 "A String", 1087 ], 1088 }, 1089 "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. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. # A note describing a provider/analysis type. 1090 "analysisKind": "A String", # The kind of analysis that is handled by this discovery. 1091 }, 1092 "dsseAttestation": { # A note describing an attestation # A note describing a dsse attestation note. 1093 "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. # DSSEHint hints at the purpose of the attestation authority. 1094 "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod". 1095 }, 1096 }, 1097 "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. 1098 "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. 1099 "longDescription": "A String", # A detailed description of this `Note`. 1100 "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" 1101 "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. 1102 "distribution": [ # The various channels by which a package is distributed. 1103 { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror 1104 "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built 1105 "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. 1106 "description": "A String", # The distribution channel-specific description of this package. 1107 "latestVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel. 1108 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1109 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1110 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1111 "name": "A String", # The main part of the version name. 1112 "revision": "A String", # The iteration of the package build from the above version. 1113 }, 1114 "maintainer": "A String", # A freeform string denoting the maintainer of this package. 1115 "url": "A String", # The distribution channel-specific homepage for this package. 1116 }, 1117 ], 1118 "name": "A String", # The name of the package. 1119 }, 1120 "relatedUrl": [ # URLs associated with this note 1121 { # Metadata for any related URL information 1122 "label": "A String", # Label to describe usage of the URL 1123 "url": "A String", # Specific URL to associate with the note 1124 }, 1125 ], 1126 "sbom": { # DocumentNote represents an SPDX Document Creation Infromation section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing a software bill of materials. 1127 "dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata") 1128 "spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file 1129 }, 1130 "shortDescription": "A String", # A one sentence description of this `Note`. 1131 "spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File. 1132 "checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package 1133 "A String", 1134 ], 1135 "fileType": "A String", # This field provides information about the type of file identified 1136 "title": "A String", # Identify the full path and filename that corresponds to the file information in this section 1137 }, 1138 "spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package. 1139 "analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document 1140 "attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts 1141 "checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file 1142 "copyright": "A String", # Identify the copyright holders of the package, as well as any dates present 1143 "detailedDescription": "A String", # A more detailed description of the package 1144 "downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created 1145 "externalRefs": [ # ExternalRef 1146 { # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 1147 "category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 1148 "comment": "A String", # Human-readable information about the purpose and target of the reference 1149 "locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location 1150 "type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category) 1151 }, 1152 ], 1153 "filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found 1154 "A String", 1155 ], 1156 "homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page 1157 "licenseDeclared": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # List the licenses that have been declared by the authors of the package 1158 "comments": "A String", # Comments 1159 "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ 1160 }, 1161 "originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came 1162 "packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc. 1163 "summaryDescription": "A String", # A short description of the package 1164 "supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file 1165 "title": "A String", # Identify the full name of the package as given by the Package Originator 1166 "verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file 1167 "version": "A String", # Identify the version of the package 1168 }, 1169 "spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing a relationship between SPDX elements. 1170 "type": "A String", # The type of relationship between the source and target SPDX elements 1171 }, 1172 "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. 1173 "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade. 1174 "distributions": [ # Metadata about the upgrade for each specific operating system. 1175 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. 1176 "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. 1177 "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. 1178 "cve": [ # The cve that would be resolved by this upgrade. 1179 "A String", 1180 ], 1181 "severity": "A String", # The severity as specified by the upstream operating system. 1182 }, 1183 ], 1184 "package": "A String", # Required - The package this Upgrade is for. 1185 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form. 1186 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1187 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1188 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1189 "name": "A String", # The main part of the version name. 1190 "revision": "A String", # The iteration of the package build from the above version. 1191 }, 1192 }, 1193 "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. 1194 "cvssScore": 3.14, # The CVSS score for this Vulnerability. 1195 "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. 1196 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 1197 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 1198 "description": "A String", # A vendor-specific description of this note. 1199 "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. 1200 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 1201 "package": "A String", # The package being described. 1202 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests. 1203 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1204 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1205 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1206 "name": "A String", # The main part of the version name. 1207 "revision": "A String", # The iteration of the package build from the above version. 1208 }, 1209 }, 1210 "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. 1211 "maxAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists. 1212 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1213 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1214 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1215 "name": "A String", # The main part of the version name. 1216 "revision": "A String", # The iteration of the package build from the above version. 1217 }, 1218 "minAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists. 1219 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1220 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1221 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1222 "name": "A String", # The main part of the version name. 1223 "revision": "A String", # The iteration of the package build from the above version. 1224 }, 1225 "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. 1226 "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) 1227 "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. 1228 "source": "A String", # The source from which the information in this Detail was obtained. 1229 "vendor": "A String", # The vendor of the product. e.g. "google" 1230 }, 1231 ], 1232 "severity": "A String", # Note provider assigned impact of the vulnerability 1233 }, 1234} 1235 1236 updateMask: string, The fields to update. 1237 x__xgafv: string, V1 error format. 1238 Allowed values 1239 1 - v1 error format 1240 2 - v2 error format 1241 1242Returns: 1243 An object of the form: 1244 1245 { # Provides a detailed description of a `Note`. 1246 "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `AttestationAuthority` for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. # A note describing an attestation role. 1247 "hint": { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify. 1248 "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". 1249 }, 1250 }, 1251 "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. 1252 "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. 1253 "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests. 1254 "v2Blob": [ # The ordered list of v2 blobs that represent a given image. 1255 "A String", 1256 ], 1257 "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests. 1258 }, 1259 "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. 1260 }, 1261 "buildType": { # Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build. 1262 "builderVersion": "A String", # Version of the builder which produced this Note. 1263 "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. 1264 "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). 1265 "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` 1266 "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` 1267 "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. 1268 }, 1269 }, 1270 "compliance": { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check. 1271 "cisBenchmark": { # A compliance check that is a CIS benchmark. # Right now we only have one compliance type, but we may add additional types in the future. 1272 "profileLevel": 42, # The profile level of this CIS benchmark check. 1273 "severity": "A String", # The severity level of this CIS benchmark check. 1274 }, 1275 "description": "A String", # A description about this compliance check. 1276 "rationale": "A String", # A rationale for the existence of this compliance check. 1277 "remediation": "A String", # A description of remediation steps if the compliance check fails. 1278 "scanInstructions": "A String", # Serialized scan instructions with a predefined format. 1279 "title": "A String", # The title that identifies this compliance check. 1280 "version": [ # The OS and config versions the benchmark applies to. 1281 { # Describes the CIS benchmark version that is applicable to a given OS and os version. 1282 "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. 1283 "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. 1284 }, 1285 ], 1286 }, 1287 "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. 1288 "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. 1289 "resourceUri": [ # Resource URI for the artifact being deployed. 1290 "A String", 1291 ], 1292 }, 1293 "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. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. # A note describing a provider/analysis type. 1294 "analysisKind": "A String", # The kind of analysis that is handled by this discovery. 1295 }, 1296 "dsseAttestation": { # A note describing an attestation # A note describing a dsse attestation note. 1297 "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. # DSSEHint hints at the purpose of the attestation authority. 1298 "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod". 1299 }, 1300 }, 1301 "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. 1302 "kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. 1303 "longDescription": "A String", # A detailed description of this `Note`. 1304 "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" 1305 "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. 1306 "distribution": [ # The various channels by which a package is distributed. 1307 { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror 1308 "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built 1309 "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. 1310 "description": "A String", # The distribution channel-specific description of this package. 1311 "latestVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel. 1312 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1313 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1314 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1315 "name": "A String", # The main part of the version name. 1316 "revision": "A String", # The iteration of the package build from the above version. 1317 }, 1318 "maintainer": "A String", # A freeform string denoting the maintainer of this package. 1319 "url": "A String", # The distribution channel-specific homepage for this package. 1320 }, 1321 ], 1322 "name": "A String", # The name of the package. 1323 }, 1324 "relatedUrl": [ # URLs associated with this note 1325 { # Metadata for any related URL information 1326 "label": "A String", # Label to describe usage of the URL 1327 "url": "A String", # Specific URL to associate with the note 1328 }, 1329 ], 1330 "sbom": { # DocumentNote represents an SPDX Document Creation Infromation section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing a software bill of materials. 1331 "dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata") 1332 "spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file 1333 }, 1334 "shortDescription": "A String", # A one sentence description of this `Note`. 1335 "spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File. 1336 "checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package 1337 "A String", 1338 ], 1339 "fileType": "A String", # This field provides information about the type of file identified 1340 "title": "A String", # Identify the full path and filename that corresponds to the file information in this section 1341 }, 1342 "spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package. 1343 "analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document 1344 "attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts 1345 "checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file 1346 "copyright": "A String", # Identify the copyright holders of the package, as well as any dates present 1347 "detailedDescription": "A String", # A more detailed description of the package 1348 "downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created 1349 "externalRefs": [ # ExternalRef 1350 { # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 1351 "category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package 1352 "comment": "A String", # Human-readable information about the purpose and target of the reference 1353 "locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location 1354 "type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category) 1355 }, 1356 ], 1357 "filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found 1358 "A String", 1359 ], 1360 "homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page 1361 "licenseDeclared": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # List the licenses that have been declared by the authors of the package 1362 "comments": "A String", # Comments 1363 "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ 1364 }, 1365 "originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came 1366 "packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc. 1367 "summaryDescription": "A String", # A short description of the package 1368 "supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file 1369 "title": "A String", # Identify the full name of the package as given by the Package Originator 1370 "verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file 1371 "version": "A String", # Identify the version of the package 1372 }, 1373 "spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing a relationship between SPDX elements. 1374 "type": "A String", # The type of relationship between the source and target SPDX elements 1375 }, 1376 "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. 1377 "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade. 1378 "distributions": [ # Metadata about the upgrade for each specific operating system. 1379 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. 1380 "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. 1381 "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. 1382 "cve": [ # The cve that would be resolved by this upgrade. 1383 "A String", 1384 ], 1385 "severity": "A String", # The severity as specified by the upstream operating system. 1386 }, 1387 ], 1388 "package": "A String", # Required - The package this Upgrade is for. 1389 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form. 1390 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1391 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1392 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1393 "name": "A String", # The main part of the version name. 1394 "revision": "A String", # The iteration of the package build from the above version. 1395 }, 1396 }, 1397 "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. 1398 "cvssScore": 3.14, # The CVSS score for this Vulnerability. 1399 "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. 1400 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 1401 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 1402 "description": "A String", # A vendor-specific description of this note. 1403 "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. 1404 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests. 1405 "package": "A String", # The package being described. 1406 "version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests. 1407 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1408 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1409 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1410 "name": "A String", # The main part of the version name. 1411 "revision": "A String", # The iteration of the package build from the above version. 1412 }, 1413 }, 1414 "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. 1415 "maxAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists. 1416 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1417 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1418 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1419 "name": "A String", # The main part of the version name. 1420 "revision": "A String", # The iteration of the package build from the above version. 1421 }, 1422 "minAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists. 1423 "epoch": 42, # Used to correct mistakes in the version numbering scheme. 1424 "inclusive": True or False, # Whether this version is vulnerable, when defining the version bounds. For example, if the minimum version is 2.0, inclusive=true would say 2.0 is vulnerable, while inclusive=false would say it's not 1425 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. 1426 "name": "A String", # The main part of the version name. 1427 "revision": "A String", # The iteration of the package build from the above version. 1428 }, 1429 "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. 1430 "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) 1431 "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. 1432 "source": "A String", # The source from which the information in this Detail was obtained. 1433 "vendor": "A String", # The vendor of the product. e.g. "google" 1434 }, 1435 ], 1436 "severity": "A String", # Note provider assigned impact of the vulnerability 1437 }, 1438}</pre> 1439</div> 1440 1441<div class="method"> 1442 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> 1443 <pre>Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes 1444 1445Args: 1446 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) 1447 body: object, The request body. 1448 The object takes the form of: 1449 1450{ # Request message for `SetIamPolicy` method. 1451 "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`, or principals, to a single `role`. Principals 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. 1452 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1453 { # Associates `members`, or principals, with a `role`. 1454 "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 principals 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). 1455 "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. 1456 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1457 "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. 1458 "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. 1459 }, 1460 "members": [ # Specifies the principals 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`. 1461 "A String", 1462 ], 1463 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1464 }, 1465 ], 1466 "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. 1467 "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). 1468 }, 1469} 1470 1471 x__xgafv: string, V1 error format. 1472 Allowed values 1473 1 - v1 error format 1474 2 - v2 error format 1475 1476Returns: 1477 An object of the form: 1478 1479 { # 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`, or principals, to a single `role`. Principals 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/). 1480 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 1481 { # Associates `members`, or principals, with a `role`. 1482 "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 principals 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). 1483 "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. 1484 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1485 "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. 1486 "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. 1487 }, 1488 "members": [ # Specifies the principals 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`. 1489 "A String", 1490 ], 1491 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1492 }, 1493 ], 1494 "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. 1495 "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). 1496}</pre> 1497</div> 1498 1499<div class="method"> 1500 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> 1501 <pre>Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes` 1502 1503Args: 1504 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required) 1505 body: object, The request body. 1506 The object takes the form of: 1507 1508{ # Request message for `TestIamPermissions` method. 1509 "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). 1510 "A String", 1511 ], 1512} 1513 1514 x__xgafv: string, V1 error format. 1515 Allowed values 1516 1 - v1 error format 1517 2 - v2 error format 1518 1519Returns: 1520 An object of the form: 1521 1522 { # Response message for `TestIamPermissions` method. 1523 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1524 "A String", 1525 ], 1526}</pre> 1527</div> 1528 1529</body></html>