| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.providers.html">providers</a> . <a href="containeranalysis_v1alpha1.providers.notes.html">notes</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="containeranalysis_v1alpha1.providers.notes.occurrences.html">occurrences()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the occurrences Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 86 | <code><a href="#create">create(name, body=None, noteId=None, parent=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 98 | <code><a href="#list">list(name, parent=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 104 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 105 | <p class="firstline">Updates an existing `Note`.</p> |
| 106 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 107 | <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 110 | <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 112 | <h3>Method Details</h3> |
| 113 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 114 | <code class="details" id="close">close()</code> |
| 115 | <pre>Close httplib2 connections.</pre> |
| 116 | </div> |
| 117 | |
| 118 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 119 | <code class="details" id="create">create(name, body=None, noteId=None, parent=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | <pre>Creates a new `Note`. |
| 121 | |
| 122 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 123 | name: string, The name of the project. Should be of the form "providers/{provider_id}". @Deprecated (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 124 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | The object takes the form of: |
| 126 | |
| 127 | { # Provides a detailed description of a `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 128 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | "builderVersion": "A String", # Version of the builder which produced this Note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 130 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. |
| 131 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` |
| 132 | "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` |
| 133 | "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. |
| 134 | "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). |
| 135 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 136 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 137 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 138 | "resourceUri": [ # Resource URI for the artifact being deployed. |
| 139 | "A String", |
| 140 | ], |
| 141 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 142 | "shortDescription": "A String", # A one sentence description of this `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 143 | "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. |
| 144 | "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. |
| 145 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. |
| 146 | "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. |
| 147 | "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. |
| 148 | "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| 149 | "A String", |
| 150 | ], |
| 151 | }, |
| 152 | "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 153 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 154 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 155 | "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" |
| 156 | "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. |
| 157 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 159 | }, |
| 160 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 161 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "distributions": [ # Metadata about the upgrade for each specific operating system. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 163 | { # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 164 | "cve": [ # The cve that would be resolved by this upgrade. |
| 165 | "A String", |
| 166 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 167 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 168 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 169 | "severity": "A String", # The severity as specified by the upstream operating system. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 170 | }, |
| 171 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 172 | "package": "A String", # Required - The package this Upgrade is for. |
| 173 | "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. |
| 174 | "name": "A String", # The main part of the version name. |
| 175 | "revision": "A String", # The iteration of the package build from the above version. |
| 176 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 177 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 178 | }, |
| 179 | }, |
| 180 | "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. |
| 181 | "analysisKind": "A String", # The kind of analysis that is handled by this discovery. |
| 182 | }, |
| 183 | "longDescription": "A String", # A detailed description of this `Note`. |
| 184 | "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. |
| 185 | "distribution": [ # The various channels by which a package is distributed. |
| 186 | { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror |
| 187 | "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. |
| 188 | "name": "A String", # The main part of the version name. |
| 189 | "revision": "A String", # The iteration of the package build from the above version. |
| 190 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 191 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 192 | }, |
| 193 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 194 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 195 | "description": "A String", # The distribution channel-specific description of this package. |
| 196 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built |
| 197 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 198 | }, |
| 199 | ], |
| 200 | "name": "A String", # The name of the package. |
| 201 | }, |
| 202 | "relatedUrl": [ # URLs associated with this note |
| 203 | { # Metadata for any related URL information |
| 204 | "url": "A String", # Specific URL to associate with the note |
| 205 | "label": "A String", # Label to describe usage of the URL |
| 206 | }, |
| 207 | ], |
| 208 | "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. |
| 209 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| 210 | "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| 211 | "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. |
| 212 | { # 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 |
| 213 | "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. |
| 214 | "name": "A String", # The main part of the version name. |
| 215 | "revision": "A String", # The iteration of the package build from the above version. |
| 216 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 217 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 218 | }, |
| 219 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 220 | "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. |
| 221 | "name": "A String", # The main part of the version name. |
| 222 | "revision": "A String", # The iteration of the package build from the above version. |
| 223 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 224 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 225 | }, |
| 226 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) |
| 227 | "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. |
| 228 | "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| 229 | "package": "A String", # The package being described. |
| 230 | "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. |
| 231 | "name": "A String", # The main part of the version name. |
| 232 | "revision": "A String", # The iteration of the package build from the above version. |
| 233 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 234 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 235 | }, |
| 236 | "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. |
| 237 | }, |
| 238 | "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 239 | "description": "A String", # A vendor-specific description of this note. |
| 240 | "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. |
| 241 | }, |
| 242 | ], |
| 243 | "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| 244 | "severity": "A String", # Note provider assigned impact of the vulnerability |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 245 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 246 | } |
| 247 | |
| 248 | noteId: string, The ID to use for this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 249 | parent: string, This field contains the project Id for example: "projects/{project_id} |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 250 | x__xgafv: string, V1 error format. |
| 251 | Allowed values |
| 252 | 1 - v1 error format |
| 253 | 2 - v2 error format |
| 254 | |
| 255 | Returns: |
| 256 | An object of the form: |
| 257 | |
| 258 | { # Provides a detailed description of a `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 259 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 260 | "builderVersion": "A String", # Version of the builder which produced this Note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 261 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. |
| 262 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` |
| 263 | "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` |
| 264 | "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. |
| 265 | "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). |
| 266 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 267 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 268 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 269 | "resourceUri": [ # Resource URI for the artifact being deployed. |
| 270 | "A String", |
| 271 | ], |
| 272 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 273 | "shortDescription": "A String", # A one sentence description of this `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 274 | "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. |
| 275 | "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. |
| 276 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. |
| 277 | "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. |
| 278 | "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. |
| 279 | "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| 280 | "A String", |
| 281 | ], |
| 282 | }, |
| 283 | "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 284 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 285 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 286 | "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" |
| 287 | "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. |
| 288 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 289 | "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". |
| 290 | }, |
| 291 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 292 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 293 | "distributions": [ # Metadata about the upgrade for each specific operating system. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 294 | { # 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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 295 | "cve": [ # The cve that would be resolved by this upgrade. |
| 296 | "A String", |
| 297 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 298 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 299 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 300 | "severity": "A String", # The severity as specified by the upstream operating system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 301 | }, |
| 302 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 303 | "package": "A String", # Required - The package this Upgrade is for. |
| 304 | "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. |
| 305 | "name": "A String", # The main part of the version name. |
| 306 | "revision": "A String", # The iteration of the package build from the above version. |
| 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 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 309 | }, |
| 310 | }, |
| 311 | "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. |
| 312 | "analysisKind": "A String", # The kind of analysis that is handled by this discovery. |
| 313 | }, |
| 314 | "longDescription": "A String", # A detailed description of this `Note`. |
| 315 | "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. |
| 316 | "distribution": [ # The various channels by which a package is distributed. |
| 317 | { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror |
| 318 | "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. |
| 319 | "name": "A String", # The main part of the version name. |
| 320 | "revision": "A String", # The iteration of the package build from the above version. |
| 321 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 322 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 323 | }, |
| 324 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 325 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 326 | "description": "A String", # The distribution channel-specific description of this package. |
| 327 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built |
| 328 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 329 | }, |
| 330 | ], |
| 331 | "name": "A String", # The name of the package. |
| 332 | }, |
| 333 | "relatedUrl": [ # URLs associated with this note |
| 334 | { # Metadata for any related URL information |
| 335 | "url": "A String", # Specific URL to associate with the note |
| 336 | "label": "A String", # Label to describe usage of the URL |
| 337 | }, |
| 338 | ], |
| 339 | "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. |
| 340 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| 341 | "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| 342 | "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. |
| 343 | { # 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 |
| 344 | "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. |
| 345 | "name": "A String", # The main part of the version name. |
| 346 | "revision": "A String", # The iteration of the package build from the above version. |
| 347 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 348 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 349 | }, |
| 350 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 351 | "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. |
| 352 | "name": "A String", # The main part of the version name. |
| 353 | "revision": "A String", # The iteration of the package build from the above version. |
| 354 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 355 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 356 | }, |
| 357 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) |
| 358 | "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. |
| 359 | "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| 360 | "package": "A String", # The package being described. |
| 361 | "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. |
| 362 | "name": "A String", # The main part of the version name. |
| 363 | "revision": "A String", # The iteration of the package build from the above version. |
| 364 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 365 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 366 | }, |
| 367 | "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. |
| 368 | }, |
| 369 | "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 370 | "description": "A String", # A vendor-specific description of this note. |
| 371 | "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. |
| 372 | }, |
| 373 | ], |
| 374 | "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| 375 | "severity": "A String", # Note provider assigned impact of the vulnerability |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 376 | }, |
| 377 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 378 | </div> |
| 379 | |
| 380 | <div class="method"> |
| 381 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 382 | <pre>Deletes the given `Note` from the system. |
| 383 | |
| 384 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 385 | name: string, The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}" (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 386 | x__xgafv: string, V1 error format. |
| 387 | Allowed values |
| 388 | 1 - v1 error format |
| 389 | 2 - v2 error format |
| 390 | |
| 391 | Returns: |
| 392 | An object of the form: |
| 393 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 394 | { # 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 `{}`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 395 | }</pre> |
| 396 | </div> |
| 397 | |
| 398 | <div class="method"> |
| 399 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 400 | <pre>Returns the requested `Note`. |
| 401 | |
| 402 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 403 | name: string, The name of the note in the form of "providers/{provider_id}/notes/{NOTE_ID}" (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 404 | x__xgafv: string, V1 error format. |
| 405 | Allowed values |
| 406 | 1 - v1 error format |
| 407 | 2 - v2 error format |
| 408 | |
| 409 | Returns: |
| 410 | An object of the form: |
| 411 | |
| 412 | { # Provides a detailed description of a `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 413 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 414 | "builderVersion": "A String", # Version of the builder which produced this Note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 415 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. |
| 416 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` |
| 417 | "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` |
| 418 | "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. |
| 419 | "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). |
| 420 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 421 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 422 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 423 | "resourceUri": [ # Resource URI for the artifact being deployed. |
| 424 | "A String", |
| 425 | ], |
| 426 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 427 | "shortDescription": "A String", # A one sentence description of this `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 428 | "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. |
| 429 | "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. |
| 430 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. |
| 431 | "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. |
| 432 | "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. |
| 433 | "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| 434 | "A String", |
| 435 | ], |
| 436 | }, |
| 437 | "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 438 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 439 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 440 | "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" |
| 441 | "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. |
| 442 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 443 | "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". |
| 444 | }, |
| 445 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 446 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 447 | "distributions": [ # Metadata about the upgrade for each specific operating system. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 448 | { # 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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 449 | "cve": [ # The cve that would be resolved by this upgrade. |
| 450 | "A String", |
| 451 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 452 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 453 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 454 | "severity": "A String", # The severity as specified by the upstream operating system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 455 | }, |
| 456 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 457 | "package": "A String", # Required - The package this Upgrade is for. |
| 458 | "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. |
| 459 | "name": "A String", # The main part of the version name. |
| 460 | "revision": "A String", # The iteration of the package build from the above version. |
| 461 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 462 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 463 | }, |
| 464 | }, |
| 465 | "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. |
| 466 | "analysisKind": "A String", # The kind of analysis that is handled by this discovery. |
| 467 | }, |
| 468 | "longDescription": "A String", # A detailed description of this `Note`. |
| 469 | "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. |
| 470 | "distribution": [ # The various channels by which a package is distributed. |
| 471 | { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror |
| 472 | "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. |
| 473 | "name": "A String", # The main part of the version name. |
| 474 | "revision": "A String", # The iteration of the package build from the above version. |
| 475 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 476 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 477 | }, |
| 478 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 479 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 480 | "description": "A String", # The distribution channel-specific description of this package. |
| 481 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built |
| 482 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 483 | }, |
| 484 | ], |
| 485 | "name": "A String", # The name of the package. |
| 486 | }, |
| 487 | "relatedUrl": [ # URLs associated with this note |
| 488 | { # Metadata for any related URL information |
| 489 | "url": "A String", # Specific URL to associate with the note |
| 490 | "label": "A String", # Label to describe usage of the URL |
| 491 | }, |
| 492 | ], |
| 493 | "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. |
| 494 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| 495 | "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| 496 | "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. |
| 497 | { # 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 |
| 498 | "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. |
| 499 | "name": "A String", # The main part of the version name. |
| 500 | "revision": "A String", # The iteration of the package build from the above version. |
| 501 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 502 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 503 | }, |
| 504 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 505 | "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. |
| 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 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 509 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 510 | }, |
| 511 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) |
| 512 | "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. |
| 513 | "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| 514 | "package": "A String", # The package being described. |
| 515 | "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. |
| 516 | "name": "A String", # The main part of the version name. |
| 517 | "revision": "A String", # The iteration of the package build from the above version. |
| 518 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 519 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 520 | }, |
| 521 | "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. |
| 522 | }, |
| 523 | "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 524 | "description": "A String", # A vendor-specific description of this note. |
| 525 | "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. |
| 526 | }, |
| 527 | ], |
| 528 | "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| 529 | "severity": "A String", # Note provider assigned impact of the vulnerability |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 530 | }, |
| 531 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 532 | </div> |
| 533 | |
| 534 | <div class="method"> |
| 535 | <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 536 | <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 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 537 | |
| 538 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 539 | resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 540 | body: object, The request body. |
| 541 | The object takes the form of: |
| 542 | |
| 543 | { # Request message for `GetIamPolicy` method. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 544 | "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. |
| 545 | "requestedPolicyVersion": 42, # Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 546 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 547 | } |
| 548 | |
| 549 | x__xgafv: string, V1 error format. |
| 550 | Allowed values |
| 551 | 1 - v1 error format |
| 552 | 2 - v2 error format |
| 553 | |
| 554 | Returns: |
| 555 | An object of the form: |
| 556 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 557 | { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| 558 | "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). |
| 559 | "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. |
| 560 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 561 | { # Associates `members` with a `role`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 562 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 563 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 564 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 565 | "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API. |
| 566 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 567 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 568 | "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. |
| 569 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 570 | "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. |
| 571 | "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. |
| 572 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 573 | }, |
| 574 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 575 | }</pre> |
| 576 | </div> |
| 577 | |
| 578 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 579 | <code class="details" id="list">list(name, parent=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 580 | <pre>Lists all `Notes` for a given project. |
| 581 | |
| 582 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 583 | name: string, The name field will contain the project Id for example: "providers/{provider_id} @Deprecated (required) |
| 584 | parent: string, This field contains the project Id for example: "projects/{PROJECT_ID}". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 585 | pageToken: string, Token to provide to skip to a particular spot in the list. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 586 | pageSize: integer, Number of notes to return in the list. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 587 | filter: string, The filter expression. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 588 | x__xgafv: string, V1 error format. |
| 589 | Allowed values |
| 590 | 1 - v1 error format |
| 591 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 592 | |
| 593 | Returns: |
| 594 | An object of the form: |
| 595 | |
| 596 | { # Response including listed notes. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 597 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 598 | "notes": [ # The occurrences requested |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 599 | { # Provides a detailed description of a `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 600 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 601 | "builderVersion": "A String", # Version of the builder which produced this Note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 602 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. |
| 603 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` |
| 604 | "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` |
| 605 | "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. |
| 606 | "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). |
| 607 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 608 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 609 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 610 | "resourceUri": [ # Resource URI for the artifact being deployed. |
| 611 | "A String", |
| 612 | ], |
| 613 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 614 | "shortDescription": "A String", # A one sentence description of this `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 615 | "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. |
| 616 | "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. |
| 617 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. |
| 618 | "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. |
| 619 | "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. |
| 620 | "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| 621 | "A String", |
| 622 | ], |
| 623 | }, |
| 624 | "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 625 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 626 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 627 | "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" |
| 628 | "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. |
| 629 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 630 | "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". |
| 631 | }, |
| 632 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 633 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 634 | "distributions": [ # Metadata about the upgrade for each specific operating system. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 635 | { # 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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 636 | "cve": [ # The cve that would be resolved by this upgrade. |
| 637 | "A String", |
| 638 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 639 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 640 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 641 | "severity": "A String", # The severity as specified by the upstream operating system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 642 | }, |
| 643 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 644 | "package": "A String", # Required - The package this Upgrade is for. |
| 645 | "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. |
| 646 | "name": "A String", # The main part of the version name. |
| 647 | "revision": "A String", # The iteration of the package build from the above version. |
| 648 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 649 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 650 | }, |
| 651 | }, |
| 652 | "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. |
| 653 | "analysisKind": "A String", # The kind of analysis that is handled by this discovery. |
| 654 | }, |
| 655 | "longDescription": "A String", # A detailed description of this `Note`. |
| 656 | "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. |
| 657 | "distribution": [ # The various channels by which a package is distributed. |
| 658 | { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror |
| 659 | "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. |
| 660 | "name": "A String", # The main part of the version name. |
| 661 | "revision": "A String", # The iteration of the package build from the above version. |
| 662 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 663 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 664 | }, |
| 665 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 666 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 667 | "description": "A String", # The distribution channel-specific description of this package. |
| 668 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built |
| 669 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 670 | }, |
| 671 | ], |
| 672 | "name": "A String", # The name of the package. |
| 673 | }, |
| 674 | "relatedUrl": [ # URLs associated with this note |
| 675 | { # Metadata for any related URL information |
| 676 | "url": "A String", # Specific URL to associate with the note |
| 677 | "label": "A String", # Label to describe usage of the URL |
| 678 | }, |
| 679 | ], |
| 680 | "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. |
| 681 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| 682 | "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| 683 | "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. |
| 684 | { # 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 |
| 685 | "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. |
| 686 | "name": "A String", # The main part of the version name. |
| 687 | "revision": "A String", # The iteration of the package build from the above version. |
| 688 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 689 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 690 | }, |
| 691 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 692 | "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. |
| 693 | "name": "A String", # The main part of the version name. |
| 694 | "revision": "A String", # The iteration of the package build from the above version. |
| 695 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 696 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 697 | }, |
| 698 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) |
| 699 | "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. |
| 700 | "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| 701 | "package": "A String", # The package being described. |
| 702 | "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. |
| 703 | "name": "A String", # The main part of the version name. |
| 704 | "revision": "A String", # The iteration of the package build from the above version. |
| 705 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 706 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 707 | }, |
| 708 | "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. |
| 709 | }, |
| 710 | "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 711 | "description": "A String", # A vendor-specific description of this note. |
| 712 | "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. |
| 713 | }, |
| 714 | ], |
| 715 | "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| 716 | "severity": "A String", # Note provider assigned impact of the vulnerability |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 717 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 718 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 719 | ], |
| 720 | }</pre> |
| 721 | </div> |
| 722 | |
| 723 | <div class="method"> |
| 724 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 725 | <pre>Retrieves the next page of results. |
| 726 | |
| 727 | Args: |
| 728 | previous_request: The request for the previous page. (required) |
| 729 | previous_response: The response from the request for the previous page. (required) |
| 730 | |
| 731 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 732 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 733 | page. Returns None if there are no more items in the collection. |
| 734 | </pre> |
| 735 | </div> |
| 736 | |
| 737 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 738 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 739 | <pre>Updates an existing `Note`. |
| 740 | |
| 741 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 742 | name: string, The name of the note. Should be of the form "projects/{provider_id}/notes/{note_id}". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 743 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 744 | The object takes the form of: |
| 745 | |
| 746 | { # Provides a detailed description of a `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 747 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 748 | "builderVersion": "A String", # Version of the builder which produced this Note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 749 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. |
| 750 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` |
| 751 | "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` |
| 752 | "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. |
| 753 | "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). |
| 754 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 755 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 756 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 757 | "resourceUri": [ # Resource URI for the artifact being deployed. |
| 758 | "A String", |
| 759 | ], |
| 760 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 761 | "shortDescription": "A String", # A one sentence description of this `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 762 | "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. |
| 763 | "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. |
| 764 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. |
| 765 | "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. |
| 766 | "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. |
| 767 | "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| 768 | "A String", |
| 769 | ], |
| 770 | }, |
| 771 | "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 772 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 773 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 774 | "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" |
| 775 | "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. |
| 776 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 777 | "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 778 | }, |
| 779 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 780 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 781 | "distributions": [ # Metadata about the upgrade for each specific operating system. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 782 | { # 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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 783 | "cve": [ # The cve that would be resolved by this upgrade. |
| 784 | "A String", |
| 785 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 786 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 787 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 788 | "severity": "A String", # The severity as specified by the upstream operating system. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 789 | }, |
| 790 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 791 | "package": "A String", # Required - The package this Upgrade is for. |
| 792 | "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. |
| 793 | "name": "A String", # The main part of the version name. |
| 794 | "revision": "A String", # The iteration of the package build from the above version. |
| 795 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 796 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 797 | }, |
| 798 | }, |
| 799 | "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. |
| 800 | "analysisKind": "A String", # The kind of analysis that is handled by this discovery. |
| 801 | }, |
| 802 | "longDescription": "A String", # A detailed description of this `Note`. |
| 803 | "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. |
| 804 | "distribution": [ # The various channels by which a package is distributed. |
| 805 | { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror |
| 806 | "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. |
| 807 | "name": "A String", # The main part of the version name. |
| 808 | "revision": "A String", # The iteration of the package build from the above version. |
| 809 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 810 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 811 | }, |
| 812 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 813 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 814 | "description": "A String", # The distribution channel-specific description of this package. |
| 815 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built |
| 816 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 817 | }, |
| 818 | ], |
| 819 | "name": "A String", # The name of the package. |
| 820 | }, |
| 821 | "relatedUrl": [ # URLs associated with this note |
| 822 | { # Metadata for any related URL information |
| 823 | "url": "A String", # Specific URL to associate with the note |
| 824 | "label": "A String", # Label to describe usage of the URL |
| 825 | }, |
| 826 | ], |
| 827 | "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. |
| 828 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| 829 | "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| 830 | "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. |
| 831 | { # 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 |
| 832 | "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. |
| 833 | "name": "A String", # The main part of the version name. |
| 834 | "revision": "A String", # The iteration of the package build from the above version. |
| 835 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 836 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 837 | }, |
| 838 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 839 | "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. |
| 840 | "name": "A String", # The main part of the version name. |
| 841 | "revision": "A String", # The iteration of the package build from the above version. |
| 842 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 843 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 844 | }, |
| 845 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) |
| 846 | "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. |
| 847 | "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| 848 | "package": "A String", # The package being described. |
| 849 | "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. |
| 850 | "name": "A String", # The main part of the version name. |
| 851 | "revision": "A String", # The iteration of the package build from the above version. |
| 852 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 853 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 854 | }, |
| 855 | "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. |
| 856 | }, |
| 857 | "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 858 | "description": "A String", # A vendor-specific description of this note. |
| 859 | "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. |
| 860 | }, |
| 861 | ], |
| 862 | "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| 863 | "severity": "A String", # Note provider assigned impact of the vulnerability |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 864 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 865 | } |
| 866 | |
| 867 | updateMask: string, The fields to update. |
| 868 | x__xgafv: string, V1 error format. |
| 869 | Allowed values |
| 870 | 1 - v1 error format |
| 871 | 2 - v2 error format |
| 872 | |
| 873 | Returns: |
| 874 | An object of the form: |
| 875 | |
| 876 | { # Provides a detailed description of a `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 877 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 878 | "builderVersion": "A String", # Version of the builder which produced this Note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 879 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. |
| 880 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` |
| 881 | "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` |
| 882 | "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. |
| 883 | "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). |
| 884 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 885 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 886 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 887 | "resourceUri": [ # Resource URI for the artifact being deployed. |
| 888 | "A String", |
| 889 | ], |
| 890 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 891 | "shortDescription": "A String", # A one sentence description of this `Note`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 892 | "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. |
| 893 | "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. |
| 894 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. |
| 895 | "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. |
| 896 | "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. |
| 897 | "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| 898 | "A String", |
| 899 | ], |
| 900 | }, |
| 901 | "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 902 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 903 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 904 | "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" |
| 905 | "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. |
| 906 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 907 | "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". |
| 908 | }, |
| 909 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 910 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 911 | "distributions": [ # Metadata about the upgrade for each specific operating system. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 912 | { # 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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 913 | "cve": [ # The cve that would be resolved by this upgrade. |
| 914 | "A String", |
| 915 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 916 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 917 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 918 | "severity": "A String", # The severity as specified by the upstream operating system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 919 | }, |
| 920 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 921 | "package": "A String", # Required - The package this Upgrade is for. |
| 922 | "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. |
| 923 | "name": "A String", # The main part of the version name. |
| 924 | "revision": "A String", # The iteration of the package build from the above version. |
| 925 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 926 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 927 | }, |
| 928 | }, |
| 929 | "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. |
| 930 | "analysisKind": "A String", # The kind of analysis that is handled by this discovery. |
| 931 | }, |
| 932 | "longDescription": "A String", # A detailed description of this `Note`. |
| 933 | "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. |
| 934 | "distribution": [ # The various channels by which a package is distributed. |
| 935 | { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror |
| 936 | "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. |
| 937 | "name": "A String", # The main part of the version name. |
| 938 | "revision": "A String", # The iteration of the package build from the above version. |
| 939 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 940 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 941 | }, |
| 942 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 943 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 944 | "description": "A String", # The distribution channel-specific description of this package. |
| 945 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built |
| 946 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 947 | }, |
| 948 | ], |
| 949 | "name": "A String", # The name of the package. |
| 950 | }, |
| 951 | "relatedUrl": [ # URLs associated with this note |
| 952 | { # Metadata for any related URL information |
| 953 | "url": "A String", # Specific URL to associate with the note |
| 954 | "label": "A String", # Label to describe usage of the URL |
| 955 | }, |
| 956 | ], |
| 957 | "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. |
| 958 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| 959 | "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| 960 | "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. |
| 961 | { # 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 |
| 962 | "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. |
| 963 | "name": "A String", # The main part of the version name. |
| 964 | "revision": "A String", # The iteration of the package build from the above version. |
| 965 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 966 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 967 | }, |
| 968 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 969 | "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. |
| 970 | "name": "A String", # The main part of the version name. |
| 971 | "revision": "A String", # The iteration of the package build from the above version. |
| 972 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 973 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 974 | }, |
| 975 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) |
| 976 | "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. |
| 977 | "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| 978 | "package": "A String", # The package being described. |
| 979 | "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. |
| 980 | "name": "A String", # The main part of the version name. |
| 981 | "revision": "A String", # The iteration of the package build from the above version. |
| 982 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 983 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 984 | }, |
| 985 | "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. |
| 986 | }, |
| 987 | "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 988 | "description": "A String", # A vendor-specific description of this note. |
| 989 | "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. |
| 990 | }, |
| 991 | ], |
| 992 | "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| 993 | "severity": "A String", # Note provider assigned impact of the vulnerability |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 994 | }, |
| 995 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 996 | </div> |
| 997 | |
| 998 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 999 | <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1000 | <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 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1001 | |
| 1002 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1003 | resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1004 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1005 | The object takes the form of: |
| 1006 | |
| 1007 | { # Request message for `SetIamPolicy` method. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1008 | "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. |
| 1009 | "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). |
| 1010 | "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. |
| 1011 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1012 | { # Associates `members` with a `role`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1013 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1014 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1015 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1016 | "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API. |
| 1017 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1018 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1019 | "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. |
| 1020 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1021 | "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. |
| 1022 | "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. |
| 1023 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1024 | }, |
| 1025 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1026 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1027 | } |
| 1028 | |
| 1029 | x__xgafv: string, V1 error format. |
| 1030 | Allowed values |
| 1031 | 1 - v1 error format |
| 1032 | 2 - v2 error format |
| 1033 | |
| 1034 | Returns: |
| 1035 | An object of the form: |
| 1036 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1037 | { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| 1038 | "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). |
| 1039 | "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. |
| 1040 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1041 | { # Associates `members` with a `role`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1042 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1043 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1044 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1045 | "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API. |
| 1046 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1047 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1048 | "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. |
| 1049 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1050 | "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. |
| 1051 | "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. |
| 1052 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1053 | }, |
| 1054 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1055 | }</pre> |
| 1056 | </div> |
| 1057 | |
| 1058 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1059 | <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1060 | <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` |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1061 | |
| 1062 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1063 | 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) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1064 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1065 | The object takes the form of: |
| 1066 | |
| 1067 | { # Request message for `TestIamPermissions` method. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1068 | "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). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1069 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1070 | ], |
| 1071 | } |
| 1072 | |
| 1073 | x__xgafv: string, V1 error format. |
| 1074 | Allowed values |
| 1075 | 1 - v1 error format |
| 1076 | 2 - v2 error format |
| 1077 | |
| 1078 | Returns: |
| 1079 | An object of the form: |
| 1080 | |
| 1081 | { # Response message for `TestIamPermissions` method. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 1082 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1083 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1084 | ], |
| 1085 | }</pre> |
| 1086 | </div> |
| 1087 | |
| 1088 | </body></html> |