| 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_v1beta1.html">Container Analysis API</a> . <a href="containeranalysis_v1beta1.projects.html">projects</a> . <a href="containeranalysis_v1beta1.projects.notes.html">notes</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="containeranalysis_v1beta1.projects.notes.occurrences.html">occurrences()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the occurrences Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 83 | <code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <p class="firstline">Creates new notes in batch.</p> |
| 85 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 86 | <code><a href="#close">close()</a></code></p> |
| 87 | <p class="firstline">Close httplib2 connections.</p> |
| 88 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 89 | <code><a href="#create">create(parent, body=None, noteId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 90 | <p class="firstline">Creates a new note.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Deletes the specified note.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 96 | <p class="firstline">Gets the specified note.</p> |
| 97 | <p class="toc_element"> |
| 98 | <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] | 99 | <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. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="toc_element"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 101 | <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | <p class="firstline">Lists notes for the specified project.</p> |
| 103 | <p class="toc_element"> |
| 104 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 105 | <p class="firstline">Retrieves the next page of results.</p> |
| 106 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 107 | <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] | 108 | <p class="firstline">Updates the specified note.</p> |
| 109 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 110 | <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] | 111 | <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. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 112 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 113 | <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] | 114 | <p class="firstline">Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 115 | <h3>Method Details</h3> |
| 116 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 117 | <code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 118 | <pre>Creates new notes in batch. |
| 119 | |
| 120 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 121 | parent: string, Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 122 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 123 | The object takes the form of: |
| 124 | |
| 125 | { # Request to create notes in batch. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "notes": { # Required. The notes to create. Max allowed length is 1000. |
| 127 | "a_key": { # A type of analysis that can be done for a resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 128 | "relatedNoteNames": [ # Other notes related to this note. |
| 129 | "A String", |
| 130 | ], |
| 131 | "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests. |
| 132 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 133 | "relatedUrl": [ # URLs associated with this note. |
| 134 | { # Metadata for any related URL information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 135 | "label": "A String", # Label to describe usage of the URL. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 136 | "url": "A String", # Specific URL associated with the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | }, |
| 138 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 139 | "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 140 | "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 141 | "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 142 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details. |
| 143 | "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). |
| 144 | "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. |
| 145 | "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` |
| 146 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 147 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 148 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 149 | "longDescription": "A String", # A detailed description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 150 | "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role. |
| 151 | "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority. |
| 152 | "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa". |
| 153 | }, |
| 154 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 155 | "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. |
| 156 | "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. |
| 157 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image. |
| 158 | "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image. |
| 159 | "A String", |
| 160 | ], |
| 161 | "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. |
| 162 | "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation. |
| 163 | }, |
| 164 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 165 | "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource. |
| 166 | "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery. |
| 167 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 168 | "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. |
| 169 | "cvssScore": 3.14, # The CVSS score for this vulnerability. |
| 170 | "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. |
| 171 | { |
| 172 | "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. |
| 173 | { |
| 174 | "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456). |
| 175 | "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ |
| 176 | }, |
| 177 | ], |
| 178 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 179 | "description": "A String", # The description of the vulnerability. |
| 180 | "name": "A String", # Required. The name of the vulnerability. |
| 181 | }, |
| 182 | ], |
| 183 | "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3. |
| 184 | "userInteraction": "A String", |
| 185 | "integrityImpact": "A String", |
| 186 | "exploitabilityScore": 3.14, |
| 187 | "impactScore": 3.14, |
| 188 | "availabilityImpact": "A String", |
| 189 | "attackComplexity": "A String", |
| 190 | "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. |
| 191 | "baseScore": 3.14, # The base score is a function of the base metric scores. |
| 192 | "confidentialityImpact": "A String", |
| 193 | "privilegesRequired": "A String", |
| 194 | "scope": "A String", |
| 195 | }, |
| 196 | "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. |
| 197 | { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 |
| 198 | "description": "A String", # A vendor-specific description of this note. |
| 199 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 200 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 201 | "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 202 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 203 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 204 | "revision": "A String", # The iteration of the package build from the above version. |
| 205 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 206 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 207 | "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 208 | "package": "A String", # Required. The name of the package where the vulnerability was found. |
| 209 | "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version. |
| 210 | "package": "A String", # Required. The package being described. |
| 211 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. |
| 212 | "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described. |
| 213 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 214 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 215 | "revision": "A String", # The iteration of the package build from the above version. |
| 216 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 217 | }, |
| 218 | }, |
| 219 | "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists. |
| 220 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 221 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 222 | "revision": "A String", # The iteration of the package build from the above version. |
| 223 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 224 | }, |
| 225 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 226 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 227 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 228 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 229 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 230 | "severity": "A String", # Note provider assigned impact of the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 231 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 232 | "shortDescription": "A String", # A one sentence description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 233 | "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 234 | "expectedProducts": [ |
| 235 | { # Defines an object to declare an in-toto artifact rule |
| 236 | "artifactRule": [ |
| 237 | "A String", |
| 238 | ], |
| 239 | }, |
| 240 | ], |
| 241 | "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. |
| 242 | { # Defines an object to declare an in-toto artifact rule |
| 243 | "artifactRule": [ |
| 244 | "A String", |
| 245 | ], |
| 246 | }, |
| 247 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 248 | "expectedCommand": [ # This field contains the expected command used to perform the step. |
| 249 | "A String", |
| 250 | ], |
| 251 | "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata. |
| 252 | { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification. |
| 253 | "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256". |
| 254 | "keyId": "A String", # key_id is an identifier for the signing key. |
| 255 | "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa". |
| 256 | "publicKeyValue": "A String", # This field contains the actual public key. |
| 257 | }, |
| 258 | ], |
| 259 | "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 260 | "stepName": "A String", # This field identifies the name of the step in the supply chain. |
| 261 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 262 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 263 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 264 | "resourceUri": [ # Required. Resource URI for the artifact being deployed. |
| 265 | "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 266 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 267 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 268 | "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. |
| 269 | "name": "A String", # Required. Immutable. The name of the package. |
| 270 | "distribution": [ # The various channels by which a package is distributed. |
| 271 | { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. |
| 272 | "description": "A String", # The distribution channel-specific description of this package. |
| 273 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 274 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 275 | "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel. |
| 276 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 277 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 278 | "revision": "A String", # The iteration of the package build from the above version. |
| 279 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 280 | }, |
| 281 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. |
| 282 | "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 283 | }, |
| 284 | ], |
| 285 | }, |
| 286 | "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 287 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 288 | }, |
| 289 | } |
| 290 | |
| 291 | x__xgafv: string, V1 error format. |
| 292 | Allowed values |
| 293 | 1 - v1 error format |
| 294 | 2 - v2 error format |
| 295 | |
| 296 | Returns: |
| 297 | An object of the form: |
| 298 | |
| 299 | { # Response for creating notes in batch. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 300 | "notes": [ # The notes that were created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 301 | { # A type of analysis that can be done for a resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 302 | "relatedNoteNames": [ # Other notes related to this note. |
| 303 | "A String", |
| 304 | ], |
| 305 | "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests. |
| 306 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 307 | "relatedUrl": [ # URLs associated with this note. |
| 308 | { # Metadata for any related URL information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 309 | "label": "A String", # Label to describe usage of the URL. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 310 | "url": "A String", # Specific URL associated with the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 311 | }, |
| 312 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 313 | "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 314 | "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 315 | "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 316 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details. |
| 317 | "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). |
| 318 | "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. |
| 319 | "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` |
| 320 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 321 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 322 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 323 | "longDescription": "A String", # A detailed description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 324 | "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role. |
| 325 | "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority. |
| 326 | "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa". |
| 327 | }, |
| 328 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 329 | "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. |
| 330 | "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. |
| 331 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image. |
| 332 | "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image. |
| 333 | "A String", |
| 334 | ], |
| 335 | "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. |
| 336 | "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation. |
| 337 | }, |
| 338 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 339 | "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource. |
| 340 | "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery. |
| 341 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 342 | "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. |
| 343 | "cvssScore": 3.14, # The CVSS score for this vulnerability. |
| 344 | "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. |
| 345 | { |
| 346 | "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. |
| 347 | { |
| 348 | "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456). |
| 349 | "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ |
| 350 | }, |
| 351 | ], |
| 352 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 353 | "description": "A String", # The description of the vulnerability. |
| 354 | "name": "A String", # Required. The name of the vulnerability. |
| 355 | }, |
| 356 | ], |
| 357 | "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3. |
| 358 | "userInteraction": "A String", |
| 359 | "integrityImpact": "A String", |
| 360 | "exploitabilityScore": 3.14, |
| 361 | "impactScore": 3.14, |
| 362 | "availabilityImpact": "A String", |
| 363 | "attackComplexity": "A String", |
| 364 | "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. |
| 365 | "baseScore": 3.14, # The base score is a function of the base metric scores. |
| 366 | "confidentialityImpact": "A String", |
| 367 | "privilegesRequired": "A String", |
| 368 | "scope": "A String", |
| 369 | }, |
| 370 | "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. |
| 371 | { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 |
| 372 | "description": "A String", # A vendor-specific description of this note. |
| 373 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 374 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 375 | "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 376 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 377 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 378 | "revision": "A String", # The iteration of the package build from the above version. |
| 379 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 380 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 381 | "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 382 | "package": "A String", # Required. The name of the package where the vulnerability was found. |
| 383 | "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version. |
| 384 | "package": "A String", # Required. The package being described. |
| 385 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. |
| 386 | "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described. |
| 387 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 388 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 389 | "revision": "A String", # The iteration of the package build from the above version. |
| 390 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 391 | }, |
| 392 | }, |
| 393 | "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists. |
| 394 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 395 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 396 | "revision": "A String", # The iteration of the package build from the above version. |
| 397 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 398 | }, |
| 399 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 400 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 401 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 402 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 403 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 404 | "severity": "A String", # Note provider assigned impact of the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 405 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 406 | "shortDescription": "A String", # A one sentence description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 407 | "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 408 | "expectedProducts": [ |
| 409 | { # Defines an object to declare an in-toto artifact rule |
| 410 | "artifactRule": [ |
| 411 | "A String", |
| 412 | ], |
| 413 | }, |
| 414 | ], |
| 415 | "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. |
| 416 | { # Defines an object to declare an in-toto artifact rule |
| 417 | "artifactRule": [ |
| 418 | "A String", |
| 419 | ], |
| 420 | }, |
| 421 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 422 | "expectedCommand": [ # This field contains the expected command used to perform the step. |
| 423 | "A String", |
| 424 | ], |
| 425 | "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata. |
| 426 | { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification. |
| 427 | "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256". |
| 428 | "keyId": "A String", # key_id is an identifier for the signing key. |
| 429 | "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa". |
| 430 | "publicKeyValue": "A String", # This field contains the actual public key. |
| 431 | }, |
| 432 | ], |
| 433 | "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 434 | "stepName": "A String", # This field identifies the name of the step in the supply chain. |
| 435 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 436 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 437 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 438 | "resourceUri": [ # Required. Resource URI for the artifact being deployed. |
| 439 | "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 440 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 441 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 442 | "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. |
| 443 | "name": "A String", # Required. Immutable. The name of the package. |
| 444 | "distribution": [ # The various channels by which a package is distributed. |
| 445 | { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. |
| 446 | "description": "A String", # The distribution channel-specific description of this package. |
| 447 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 448 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 449 | "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel. |
| 450 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 451 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 452 | "revision": "A String", # The iteration of the package build from the above version. |
| 453 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 454 | }, |
| 455 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. |
| 456 | "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 457 | }, |
| 458 | ], |
| 459 | }, |
| 460 | "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 461 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 462 | ], |
| 463 | }</pre> |
| 464 | </div> |
| 465 | |
| 466 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 467 | <code class="details" id="close">close()</code> |
| 468 | <pre>Close httplib2 connections.</pre> |
| 469 | </div> |
| 470 | |
| 471 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 472 | <code class="details" id="create">create(parent, body=None, noteId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 473 | <pre>Creates a new note. |
| 474 | |
| 475 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 476 | parent: string, Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 477 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 478 | The object takes the form of: |
| 479 | |
| 480 | { # A type of analysis that can be done for a resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 481 | "relatedNoteNames": [ # Other notes related to this note. |
| 482 | "A String", |
| 483 | ], |
| 484 | "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests. |
| 485 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 486 | "relatedUrl": [ # URLs associated with this note. |
| 487 | { # Metadata for any related URL information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 488 | "label": "A String", # Label to describe usage of the URL. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 489 | "url": "A String", # Specific URL associated with the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 490 | }, |
| 491 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 492 | "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 493 | "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 494 | "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 495 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details. |
| 496 | "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). |
| 497 | "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. |
| 498 | "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` |
| 499 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 500 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 501 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 502 | "longDescription": "A String", # A detailed description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 503 | "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role. |
| 504 | "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority. |
| 505 | "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa". |
| 506 | }, |
| 507 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 508 | "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. |
| 509 | "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. |
| 510 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image. |
| 511 | "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image. |
| 512 | "A String", |
| 513 | ], |
| 514 | "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. |
| 515 | "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation. |
| 516 | }, |
| 517 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 518 | "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource. |
| 519 | "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery. |
| 520 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 521 | "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. |
| 522 | "cvssScore": 3.14, # The CVSS score for this vulnerability. |
| 523 | "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. |
| 524 | { |
| 525 | "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. |
| 526 | { |
| 527 | "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456). |
| 528 | "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ |
| 529 | }, |
| 530 | ], |
| 531 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 532 | "description": "A String", # The description of the vulnerability. |
| 533 | "name": "A String", # Required. The name of the vulnerability. |
| 534 | }, |
| 535 | ], |
| 536 | "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3. |
| 537 | "userInteraction": "A String", |
| 538 | "integrityImpact": "A String", |
| 539 | "exploitabilityScore": 3.14, |
| 540 | "impactScore": 3.14, |
| 541 | "availabilityImpact": "A String", |
| 542 | "attackComplexity": "A String", |
| 543 | "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. |
| 544 | "baseScore": 3.14, # The base score is a function of the base metric scores. |
| 545 | "confidentialityImpact": "A String", |
| 546 | "privilegesRequired": "A String", |
| 547 | "scope": "A String", |
| 548 | }, |
| 549 | "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. |
| 550 | { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 |
| 551 | "description": "A String", # A vendor-specific description of this note. |
| 552 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 553 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 554 | "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 555 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 556 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 557 | "revision": "A String", # The iteration of the package build from the above version. |
| 558 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 559 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 560 | "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 561 | "package": "A String", # Required. The name of the package where the vulnerability was found. |
| 562 | "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version. |
| 563 | "package": "A String", # Required. The package being described. |
| 564 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. |
| 565 | "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described. |
| 566 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 567 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 568 | "revision": "A String", # The iteration of the package build from the above version. |
| 569 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 570 | }, |
| 571 | }, |
| 572 | "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists. |
| 573 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 574 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 575 | "revision": "A String", # The iteration of the package build from the above version. |
| 576 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 577 | }, |
| 578 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 579 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 580 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 581 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 582 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 583 | "severity": "A String", # Note provider assigned impact of the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 584 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 585 | "shortDescription": "A String", # A one sentence description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 586 | "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 587 | "expectedProducts": [ |
| 588 | { # Defines an object to declare an in-toto artifact rule |
| 589 | "artifactRule": [ |
| 590 | "A String", |
| 591 | ], |
| 592 | }, |
| 593 | ], |
| 594 | "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. |
| 595 | { # Defines an object to declare an in-toto artifact rule |
| 596 | "artifactRule": [ |
| 597 | "A String", |
| 598 | ], |
| 599 | }, |
| 600 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 601 | "expectedCommand": [ # This field contains the expected command used to perform the step. |
| 602 | "A String", |
| 603 | ], |
| 604 | "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata. |
| 605 | { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification. |
| 606 | "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256". |
| 607 | "keyId": "A String", # key_id is an identifier for the signing key. |
| 608 | "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa". |
| 609 | "publicKeyValue": "A String", # This field contains the actual public key. |
| 610 | }, |
| 611 | ], |
| 612 | "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 613 | "stepName": "A String", # This field identifies the name of the step in the supply chain. |
| 614 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 615 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 616 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 617 | "resourceUri": [ # Required. Resource URI for the artifact being deployed. |
| 618 | "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 619 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 620 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 621 | "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. |
| 622 | "name": "A String", # Required. Immutable. The name of the package. |
| 623 | "distribution": [ # The various channels by which a package is distributed. |
| 624 | { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. |
| 625 | "description": "A String", # The distribution channel-specific description of this package. |
| 626 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 627 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 628 | "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel. |
| 629 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 630 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 631 | "revision": "A String", # The iteration of the package build from the above version. |
| 632 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 633 | }, |
| 634 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. |
| 635 | "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 636 | }, |
| 637 | ], |
| 638 | }, |
| 639 | "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 640 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 641 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 642 | noteId: string, Required. The ID to use for this note. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 643 | x__xgafv: string, V1 error format. |
| 644 | Allowed values |
| 645 | 1 - v1 error format |
| 646 | 2 - v2 error format |
| 647 | |
| 648 | Returns: |
| 649 | An object of the form: |
| 650 | |
| 651 | { # A type of analysis that can be done for a resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 652 | "relatedNoteNames": [ # Other notes related to this note. |
| 653 | "A String", |
| 654 | ], |
| 655 | "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests. |
| 656 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 657 | "relatedUrl": [ # URLs associated with this note. |
| 658 | { # Metadata for any related URL information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 659 | "label": "A String", # Label to describe usage of the URL. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 660 | "url": "A String", # Specific URL associated with the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 661 | }, |
| 662 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 663 | "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 664 | "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 665 | "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 666 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details. |
| 667 | "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). |
| 668 | "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. |
| 669 | "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` |
| 670 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 671 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 672 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 673 | "longDescription": "A String", # A detailed description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 674 | "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role. |
| 675 | "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority. |
| 676 | "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa". |
| 677 | }, |
| 678 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 679 | "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. |
| 680 | "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. |
| 681 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image. |
| 682 | "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image. |
| 683 | "A String", |
| 684 | ], |
| 685 | "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. |
| 686 | "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation. |
| 687 | }, |
| 688 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 689 | "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource. |
| 690 | "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery. |
| 691 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 692 | "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. |
| 693 | "cvssScore": 3.14, # The CVSS score for this vulnerability. |
| 694 | "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. |
| 695 | { |
| 696 | "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. |
| 697 | { |
| 698 | "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456). |
| 699 | "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ |
| 700 | }, |
| 701 | ], |
| 702 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 703 | "description": "A String", # The description of the vulnerability. |
| 704 | "name": "A String", # Required. The name of the vulnerability. |
| 705 | }, |
| 706 | ], |
| 707 | "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3. |
| 708 | "userInteraction": "A String", |
| 709 | "integrityImpact": "A String", |
| 710 | "exploitabilityScore": 3.14, |
| 711 | "impactScore": 3.14, |
| 712 | "availabilityImpact": "A String", |
| 713 | "attackComplexity": "A String", |
| 714 | "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. |
| 715 | "baseScore": 3.14, # The base score is a function of the base metric scores. |
| 716 | "confidentialityImpact": "A String", |
| 717 | "privilegesRequired": "A String", |
| 718 | "scope": "A String", |
| 719 | }, |
| 720 | "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. |
| 721 | { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 |
| 722 | "description": "A String", # A vendor-specific description of this note. |
| 723 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 724 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 725 | "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 726 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 727 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 728 | "revision": "A String", # The iteration of the package build from the above version. |
| 729 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 730 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 731 | "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 732 | "package": "A String", # Required. The name of the package where the vulnerability was found. |
| 733 | "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version. |
| 734 | "package": "A String", # Required. The package being described. |
| 735 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. |
| 736 | "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described. |
| 737 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 738 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 739 | "revision": "A String", # The iteration of the package build from the above version. |
| 740 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 741 | }, |
| 742 | }, |
| 743 | "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists. |
| 744 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 745 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 746 | "revision": "A String", # The iteration of the package build from the above version. |
| 747 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 748 | }, |
| 749 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 750 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 751 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 752 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 753 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 754 | "severity": "A String", # Note provider assigned impact of the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 755 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 756 | "shortDescription": "A String", # A one sentence description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 757 | "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 758 | "expectedProducts": [ |
| 759 | { # Defines an object to declare an in-toto artifact rule |
| 760 | "artifactRule": [ |
| 761 | "A String", |
| 762 | ], |
| 763 | }, |
| 764 | ], |
| 765 | "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. |
| 766 | { # Defines an object to declare an in-toto artifact rule |
| 767 | "artifactRule": [ |
| 768 | "A String", |
| 769 | ], |
| 770 | }, |
| 771 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 772 | "expectedCommand": [ # This field contains the expected command used to perform the step. |
| 773 | "A String", |
| 774 | ], |
| 775 | "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata. |
| 776 | { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification. |
| 777 | "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256". |
| 778 | "keyId": "A String", # key_id is an identifier for the signing key. |
| 779 | "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa". |
| 780 | "publicKeyValue": "A String", # This field contains the actual public key. |
| 781 | }, |
| 782 | ], |
| 783 | "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 784 | "stepName": "A String", # This field identifies the name of the step in the supply chain. |
| 785 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 786 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 787 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 788 | "resourceUri": [ # Required. Resource URI for the artifact being deployed. |
| 789 | "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 790 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 791 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 792 | "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. |
| 793 | "name": "A String", # Required. Immutable. The name of the package. |
| 794 | "distribution": [ # The various channels by which a package is distributed. |
| 795 | { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. |
| 796 | "description": "A String", # The distribution channel-specific description of this package. |
| 797 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 798 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 799 | "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel. |
| 800 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 801 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 802 | "revision": "A String", # The iteration of the package build from the above version. |
| 803 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 804 | }, |
| 805 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. |
| 806 | "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 807 | }, |
| 808 | ], |
| 809 | }, |
| 810 | "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 811 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 812 | </div> |
| 813 | |
| 814 | <div class="method"> |
| 815 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 816 | <pre>Deletes the specified note. |
| 817 | |
| 818 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 819 | name: string, Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 820 | x__xgafv: string, V1 error format. |
| 821 | Allowed values |
| 822 | 1 - v1 error format |
| 823 | 2 - v2 error format |
| 824 | |
| 825 | Returns: |
| 826 | An object of the form: |
| 827 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 828 | { # 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] | 829 | }</pre> |
| 830 | </div> |
| 831 | |
| 832 | <div class="method"> |
| 833 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 834 | <pre>Gets the specified note. |
| 835 | |
| 836 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 837 | name: string, Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 838 | x__xgafv: string, V1 error format. |
| 839 | Allowed values |
| 840 | 1 - v1 error format |
| 841 | 2 - v2 error format |
| 842 | |
| 843 | Returns: |
| 844 | An object of the form: |
| 845 | |
| 846 | { # A type of analysis that can be done for a resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 847 | "relatedNoteNames": [ # Other notes related to this note. |
| 848 | "A String", |
| 849 | ], |
| 850 | "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests. |
| 851 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 852 | "relatedUrl": [ # URLs associated with this note. |
| 853 | { # Metadata for any related URL information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 854 | "label": "A String", # Label to describe usage of the URL. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 855 | "url": "A String", # Specific URL associated with the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 856 | }, |
| 857 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 858 | "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 859 | "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 860 | "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 861 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details. |
| 862 | "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). |
| 863 | "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. |
| 864 | "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` |
| 865 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 866 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 867 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 868 | "longDescription": "A String", # A detailed description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 869 | "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role. |
| 870 | "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority. |
| 871 | "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa". |
| 872 | }, |
| 873 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 874 | "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. |
| 875 | "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. |
| 876 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image. |
| 877 | "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image. |
| 878 | "A String", |
| 879 | ], |
| 880 | "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. |
| 881 | "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation. |
| 882 | }, |
| 883 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 884 | "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource. |
| 885 | "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery. |
| 886 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 887 | "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. |
| 888 | "cvssScore": 3.14, # The CVSS score for this vulnerability. |
| 889 | "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. |
| 890 | { |
| 891 | "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. |
| 892 | { |
| 893 | "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456). |
| 894 | "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ |
| 895 | }, |
| 896 | ], |
| 897 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 898 | "description": "A String", # The description of the vulnerability. |
| 899 | "name": "A String", # Required. The name of the vulnerability. |
| 900 | }, |
| 901 | ], |
| 902 | "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3. |
| 903 | "userInteraction": "A String", |
| 904 | "integrityImpact": "A String", |
| 905 | "exploitabilityScore": 3.14, |
| 906 | "impactScore": 3.14, |
| 907 | "availabilityImpact": "A String", |
| 908 | "attackComplexity": "A String", |
| 909 | "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. |
| 910 | "baseScore": 3.14, # The base score is a function of the base metric scores. |
| 911 | "confidentialityImpact": "A String", |
| 912 | "privilegesRequired": "A String", |
| 913 | "scope": "A String", |
| 914 | }, |
| 915 | "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. |
| 916 | { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 |
| 917 | "description": "A String", # A vendor-specific description of this note. |
| 918 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 919 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 920 | "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 921 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 922 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 923 | "revision": "A String", # The iteration of the package build from the above version. |
| 924 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 925 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 926 | "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 927 | "package": "A String", # Required. The name of the package where the vulnerability was found. |
| 928 | "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version. |
| 929 | "package": "A String", # Required. The package being described. |
| 930 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. |
| 931 | "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described. |
| 932 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 933 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 934 | "revision": "A String", # The iteration of the package build from the above version. |
| 935 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 936 | }, |
| 937 | }, |
| 938 | "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists. |
| 939 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 940 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 941 | "revision": "A String", # The iteration of the package build from the above version. |
| 942 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 943 | }, |
| 944 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 945 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 946 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 947 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 948 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 949 | "severity": "A String", # Note provider assigned impact of the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 950 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 951 | "shortDescription": "A String", # A one sentence description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 952 | "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 953 | "expectedProducts": [ |
| 954 | { # Defines an object to declare an in-toto artifact rule |
| 955 | "artifactRule": [ |
| 956 | "A String", |
| 957 | ], |
| 958 | }, |
| 959 | ], |
| 960 | "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. |
| 961 | { # Defines an object to declare an in-toto artifact rule |
| 962 | "artifactRule": [ |
| 963 | "A String", |
| 964 | ], |
| 965 | }, |
| 966 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 967 | "expectedCommand": [ # This field contains the expected command used to perform the step. |
| 968 | "A String", |
| 969 | ], |
| 970 | "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata. |
| 971 | { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification. |
| 972 | "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256". |
| 973 | "keyId": "A String", # key_id is an identifier for the signing key. |
| 974 | "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa". |
| 975 | "publicKeyValue": "A String", # This field contains the actual public key. |
| 976 | }, |
| 977 | ], |
| 978 | "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 979 | "stepName": "A String", # This field identifies the name of the step in the supply chain. |
| 980 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 981 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 982 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 983 | "resourceUri": [ # Required. Resource URI for the artifact being deployed. |
| 984 | "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 985 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 986 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 987 | "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. |
| 988 | "name": "A String", # Required. Immutable. The name of the package. |
| 989 | "distribution": [ # The various channels by which a package is distributed. |
| 990 | { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. |
| 991 | "description": "A String", # The distribution channel-specific description of this package. |
| 992 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 993 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 994 | "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel. |
| 995 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 996 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 997 | "revision": "A String", # The iteration of the package build from the above version. |
| 998 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 999 | }, |
| 1000 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. |
| 1001 | "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 1002 | }, |
| 1003 | ], |
| 1004 | }, |
| 1005 | "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1006 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1007 | </div> |
| 1008 | |
| 1009 | <div class="method"> |
| 1010 | <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] | 1011 | <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. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1012 | |
| 1013 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1014 | 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] | 1015 | body: object, The request body. |
| 1016 | The object takes the form of: |
| 1017 | |
| 1018 | { # Request message for `GetIamPolicy` method. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1019 | "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. |
| 1020 | "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] | 1021 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1022 | } |
| 1023 | |
| 1024 | x__xgafv: string, V1 error format. |
| 1025 | Allowed values |
| 1026 | 1 - v1 error format |
| 1027 | 2 - v2 error format |
| 1028 | |
| 1029 | Returns: |
| 1030 | An object of the form: |
| 1031 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1032 | { # 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/). |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1033 | "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). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1034 | "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] | 1035 | { # Associates `members` with a `role`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1036 | "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 | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1037 | "A String", |
| 1038 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1039 | "bindingId": "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1040 | "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). |
| 1041 | "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. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1042 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1043 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1044 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1045 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1046 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1047 | }, |
| 1048 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1049 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1050 | }</pre> |
| 1051 | </div> |
| 1052 | |
| 1053 | <div class="method"> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1054 | <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1055 | <pre>Lists notes for the specified project. |
| 1056 | |
| 1057 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1058 | parent: string, Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1059 | filter: string, The filter expression. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1060 | pageSize: integer, Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1061 | pageToken: string, Token to provide to skip to a particular spot in the list. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1062 | x__xgafv: string, V1 error format. |
| 1063 | Allowed values |
| 1064 | 1 - v1 error format |
| 1065 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1066 | |
| 1067 | Returns: |
| 1068 | An object of the form: |
| 1069 | |
| 1070 | { # Response for listing notes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1071 | "notes": [ # The notes requested. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1072 | { # A type of analysis that can be done for a resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1073 | "relatedNoteNames": [ # Other notes related to this note. |
| 1074 | "A String", |
| 1075 | ], |
| 1076 | "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests. |
| 1077 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1078 | "relatedUrl": [ # URLs associated with this note. |
| 1079 | { # Metadata for any related URL information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1080 | "label": "A String", # Label to describe usage of the URL. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1081 | "url": "A String", # Specific URL associated with the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1082 | }, |
| 1083 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1084 | "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1085 | "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1086 | "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1087 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details. |
| 1088 | "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). |
| 1089 | "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. |
| 1090 | "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` |
| 1091 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1092 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1093 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1094 | "longDescription": "A String", # A detailed description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1095 | "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role. |
| 1096 | "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority. |
| 1097 | "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa". |
| 1098 | }, |
| 1099 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1100 | "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. |
| 1101 | "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. |
| 1102 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image. |
| 1103 | "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image. |
| 1104 | "A String", |
| 1105 | ], |
| 1106 | "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. |
| 1107 | "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation. |
| 1108 | }, |
| 1109 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1110 | "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource. |
| 1111 | "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery. |
| 1112 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1113 | "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. |
| 1114 | "cvssScore": 3.14, # The CVSS score for this vulnerability. |
| 1115 | "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. |
| 1116 | { |
| 1117 | "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. |
| 1118 | { |
| 1119 | "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456). |
| 1120 | "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ |
| 1121 | }, |
| 1122 | ], |
| 1123 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 1124 | "description": "A String", # The description of the vulnerability. |
| 1125 | "name": "A String", # Required. The name of the vulnerability. |
| 1126 | }, |
| 1127 | ], |
| 1128 | "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3. |
| 1129 | "userInteraction": "A String", |
| 1130 | "integrityImpact": "A String", |
| 1131 | "exploitabilityScore": 3.14, |
| 1132 | "impactScore": 3.14, |
| 1133 | "availabilityImpact": "A String", |
| 1134 | "attackComplexity": "A String", |
| 1135 | "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. |
| 1136 | "baseScore": 3.14, # The base score is a function of the base metric scores. |
| 1137 | "confidentialityImpact": "A String", |
| 1138 | "privilegesRequired": "A String", |
| 1139 | "scope": "A String", |
| 1140 | }, |
| 1141 | "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. |
| 1142 | { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 |
| 1143 | "description": "A String", # A vendor-specific description of this note. |
| 1144 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 1145 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 1146 | "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1147 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1148 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1149 | "revision": "A String", # The iteration of the package build from the above version. |
| 1150 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1151 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1152 | "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 1153 | "package": "A String", # Required. The name of the package where the vulnerability was found. |
| 1154 | "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version. |
| 1155 | "package": "A String", # Required. The package being described. |
| 1156 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. |
| 1157 | "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described. |
| 1158 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 1159 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 1160 | "revision": "A String", # The iteration of the package build from the above version. |
| 1161 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 1162 | }, |
| 1163 | }, |
| 1164 | "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists. |
| 1165 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 1166 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 1167 | "revision": "A String", # The iteration of the package build from the above version. |
| 1168 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 1169 | }, |
| 1170 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 1171 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1172 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1173 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1174 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 1175 | "severity": "A String", # Note provider assigned impact of the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1176 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1177 | "shortDescription": "A String", # A one sentence description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1178 | "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1179 | "expectedProducts": [ |
| 1180 | { # Defines an object to declare an in-toto artifact rule |
| 1181 | "artifactRule": [ |
| 1182 | "A String", |
| 1183 | ], |
| 1184 | }, |
| 1185 | ], |
| 1186 | "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. |
| 1187 | { # Defines an object to declare an in-toto artifact rule |
| 1188 | "artifactRule": [ |
| 1189 | "A String", |
| 1190 | ], |
| 1191 | }, |
| 1192 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1193 | "expectedCommand": [ # This field contains the expected command used to perform the step. |
| 1194 | "A String", |
| 1195 | ], |
| 1196 | "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata. |
| 1197 | { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification. |
| 1198 | "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256". |
| 1199 | "keyId": "A String", # key_id is an identifier for the signing key. |
| 1200 | "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa". |
| 1201 | "publicKeyValue": "A String", # This field contains the actual public key. |
| 1202 | }, |
| 1203 | ], |
| 1204 | "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1205 | "stepName": "A String", # This field identifies the name of the step in the supply chain. |
| 1206 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1207 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 1208 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 1209 | "resourceUri": [ # Required. Resource URI for the artifact being deployed. |
| 1210 | "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1211 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1212 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1213 | "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. |
| 1214 | "name": "A String", # Required. Immutable. The name of the package. |
| 1215 | "distribution": [ # The various channels by which a package is distributed. |
| 1216 | { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. |
| 1217 | "description": "A String", # The distribution channel-specific description of this package. |
| 1218 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 1219 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 1220 | "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel. |
| 1221 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 1222 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 1223 | "revision": "A String", # The iteration of the package build from the above version. |
| 1224 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 1225 | }, |
| 1226 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. |
| 1227 | "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 1228 | }, |
| 1229 | ], |
| 1230 | }, |
| 1231 | "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1232 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1233 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1234 | "nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1235 | }</pre> |
| 1236 | </div> |
| 1237 | |
| 1238 | <div class="method"> |
| 1239 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1240 | <pre>Retrieves the next page of results. |
| 1241 | |
| 1242 | Args: |
| 1243 | previous_request: The request for the previous page. (required) |
| 1244 | previous_response: The response from the request for the previous page. (required) |
| 1245 | |
| 1246 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1247 | 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] | 1248 | page. Returns None if there are no more items in the collection. |
| 1249 | </pre> |
| 1250 | </div> |
| 1251 | |
| 1252 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1253 | <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] | 1254 | <pre>Updates the specified note. |
| 1255 | |
| 1256 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1257 | name: string, Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1258 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1259 | The object takes the form of: |
| 1260 | |
| 1261 | { # A type of analysis that can be done for a resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1262 | "relatedNoteNames": [ # Other notes related to this note. |
| 1263 | "A String", |
| 1264 | ], |
| 1265 | "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests. |
| 1266 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1267 | "relatedUrl": [ # URLs associated with this note. |
| 1268 | { # Metadata for any related URL information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1269 | "label": "A String", # Label to describe usage of the URL. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1270 | "url": "A String", # Specific URL associated with the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1271 | }, |
| 1272 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1273 | "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1274 | "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1275 | "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1276 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details. |
| 1277 | "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). |
| 1278 | "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. |
| 1279 | "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` |
| 1280 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1281 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1282 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1283 | "longDescription": "A String", # A detailed description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1284 | "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role. |
| 1285 | "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority. |
| 1286 | "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa". |
| 1287 | }, |
| 1288 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1289 | "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. |
| 1290 | "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. |
| 1291 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image. |
| 1292 | "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image. |
| 1293 | "A String", |
| 1294 | ], |
| 1295 | "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. |
| 1296 | "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation. |
| 1297 | }, |
| 1298 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1299 | "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource. |
| 1300 | "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery. |
| 1301 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1302 | "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. |
| 1303 | "cvssScore": 3.14, # The CVSS score for this vulnerability. |
| 1304 | "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. |
| 1305 | { |
| 1306 | "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. |
| 1307 | { |
| 1308 | "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456). |
| 1309 | "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ |
| 1310 | }, |
| 1311 | ], |
| 1312 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 1313 | "description": "A String", # The description of the vulnerability. |
| 1314 | "name": "A String", # Required. The name of the vulnerability. |
| 1315 | }, |
| 1316 | ], |
| 1317 | "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3. |
| 1318 | "userInteraction": "A String", |
| 1319 | "integrityImpact": "A String", |
| 1320 | "exploitabilityScore": 3.14, |
| 1321 | "impactScore": 3.14, |
| 1322 | "availabilityImpact": "A String", |
| 1323 | "attackComplexity": "A String", |
| 1324 | "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. |
| 1325 | "baseScore": 3.14, # The base score is a function of the base metric scores. |
| 1326 | "confidentialityImpact": "A String", |
| 1327 | "privilegesRequired": "A String", |
| 1328 | "scope": "A String", |
| 1329 | }, |
| 1330 | "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. |
| 1331 | { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 |
| 1332 | "description": "A String", # A vendor-specific description of this note. |
| 1333 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 1334 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 1335 | "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1336 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1337 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1338 | "revision": "A String", # The iteration of the package build from the above version. |
| 1339 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1340 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1341 | "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 1342 | "package": "A String", # Required. The name of the package where the vulnerability was found. |
| 1343 | "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version. |
| 1344 | "package": "A String", # Required. The package being described. |
| 1345 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. |
| 1346 | "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described. |
| 1347 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 1348 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 1349 | "revision": "A String", # The iteration of the package build from the above version. |
| 1350 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 1351 | }, |
| 1352 | }, |
| 1353 | "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists. |
| 1354 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 1355 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 1356 | "revision": "A String", # The iteration of the package build from the above version. |
| 1357 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 1358 | }, |
| 1359 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 1360 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1361 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1362 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1363 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 1364 | "severity": "A String", # Note provider assigned impact of the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1365 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1366 | "shortDescription": "A String", # A one sentence description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1367 | "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1368 | "expectedProducts": [ |
| 1369 | { # Defines an object to declare an in-toto artifact rule |
| 1370 | "artifactRule": [ |
| 1371 | "A String", |
| 1372 | ], |
| 1373 | }, |
| 1374 | ], |
| 1375 | "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. |
| 1376 | { # Defines an object to declare an in-toto artifact rule |
| 1377 | "artifactRule": [ |
| 1378 | "A String", |
| 1379 | ], |
| 1380 | }, |
| 1381 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1382 | "expectedCommand": [ # This field contains the expected command used to perform the step. |
| 1383 | "A String", |
| 1384 | ], |
| 1385 | "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata. |
| 1386 | { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification. |
| 1387 | "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256". |
| 1388 | "keyId": "A String", # key_id is an identifier for the signing key. |
| 1389 | "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa". |
| 1390 | "publicKeyValue": "A String", # This field contains the actual public key. |
| 1391 | }, |
| 1392 | ], |
| 1393 | "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1394 | "stepName": "A String", # This field identifies the name of the step in the supply chain. |
| 1395 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1396 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 1397 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 1398 | "resourceUri": [ # Required. Resource URI for the artifact being deployed. |
| 1399 | "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1400 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1401 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1402 | "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. |
| 1403 | "name": "A String", # Required. Immutable. The name of the package. |
| 1404 | "distribution": [ # The various channels by which a package is distributed. |
| 1405 | { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. |
| 1406 | "description": "A String", # The distribution channel-specific description of this package. |
| 1407 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 1408 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 1409 | "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel. |
| 1410 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 1411 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 1412 | "revision": "A String", # The iteration of the package build from the above version. |
| 1413 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 1414 | }, |
| 1415 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. |
| 1416 | "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 1417 | }, |
| 1418 | ], |
| 1419 | }, |
| 1420 | "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1421 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1422 | |
| 1423 | updateMask: string, The fields to update. |
| 1424 | x__xgafv: string, V1 error format. |
| 1425 | Allowed values |
| 1426 | 1 - v1 error format |
| 1427 | 2 - v2 error format |
| 1428 | |
| 1429 | Returns: |
| 1430 | An object of the form: |
| 1431 | |
| 1432 | { # A type of analysis that can be done for a resource. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1433 | "relatedNoteNames": [ # Other notes related to this note. |
| 1434 | "A String", |
| 1435 | ], |
| 1436 | "kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests. |
| 1437 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1438 | "relatedUrl": [ # URLs associated with this note. |
| 1439 | { # Metadata for any related URL information. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1440 | "label": "A String", # Label to describe usage of the URL. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1441 | "url": "A String", # Specific URL associated with the resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1442 | }, |
| 1443 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1444 | "expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1445 | "build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1446 | "builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1447 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details. |
| 1448 | "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). |
| 1449 | "signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded. |
| 1450 | "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` |
| 1451 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1452 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1453 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1454 | "longDescription": "A String", # A detailed description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1455 | "attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role. |
| 1456 | "hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority. |
| 1457 | "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa". |
| 1458 | }, |
| 1459 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1460 | "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. |
| 1461 | "resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images. |
| 1462 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image. |
| 1463 | "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image. |
| 1464 | "A String", |
| 1465 | ], |
| 1466 | "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. |
| 1467 | "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation. |
| 1468 | }, |
| 1469 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1470 | "discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource. |
| 1471 | "analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery. |
| 1472 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1473 | "vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability. |
| 1474 | "cvssScore": 3.14, # The CVSS score for this vulnerability. |
| 1475 | "windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version. |
| 1476 | { |
| 1477 | "fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix. |
| 1478 | { |
| 1479 | "name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456). |
| 1480 | "url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/ |
| 1481 | }, |
| 1482 | ], |
| 1483 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 1484 | "description": "A String", # The description of the vulnerability. |
| 1485 | "name": "A String", # Required. The name of the vulnerability. |
| 1486 | }, |
| 1487 | ], |
| 1488 | "cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3. |
| 1489 | "userInteraction": "A String", |
| 1490 | "integrityImpact": "A String", |
| 1491 | "exploitabilityScore": 3.14, |
| 1492 | "impactScore": 3.14, |
| 1493 | "availabilityImpact": "A String", |
| 1494 | "attackComplexity": "A String", |
| 1495 | "attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. |
| 1496 | "baseScore": 3.14, # The base score is a function of the base metric scores. |
| 1497 | "confidentialityImpact": "A String", |
| 1498 | "privilegesRequired": "A String", |
| 1499 | "scope": "A String", |
| 1500 | }, |
| 1501 | "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. |
| 1502 | { # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2 |
| 1503 | "description": "A String", # A vendor-specific description of this note. |
| 1504 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. |
| 1505 | "severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability. |
| 1506 | "minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1507 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1508 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1509 | "revision": "A String", # The iteration of the package build from the above version. |
| 1510 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1511 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1512 | "isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 1513 | "package": "A String", # Required. The name of the package where the vulnerability was found. |
| 1514 | "fixedLocation": { # The location of the vulnerability. # The fix for this specific package version. |
| 1515 | "package": "A String", # Required. The package being described. |
| 1516 | "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. |
| 1517 | "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described. |
| 1518 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 1519 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 1520 | "revision": "A String", # The iteration of the package build from the above version. |
| 1521 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 1522 | }, |
| 1523 | }, |
| 1524 | "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists. |
| 1525 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 1526 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 1527 | "revision": "A String", # The iteration of the package build from the above version. |
| 1528 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 1529 | }, |
| 1530 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 1531 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1532 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1533 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1534 | "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker. |
| 1535 | "severity": "A String", # Note provider assigned impact of the vulnerability. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1536 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1537 | "shortDescription": "A String", # A one sentence description of this note. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1538 | "intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1539 | "expectedProducts": [ |
| 1540 | { # Defines an object to declare an in-toto artifact rule |
| 1541 | "artifactRule": [ |
| 1542 | "A String", |
| 1543 | ], |
| 1544 | }, |
| 1545 | ], |
| 1546 | "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. |
| 1547 | { # Defines an object to declare an in-toto artifact rule |
| 1548 | "artifactRule": [ |
| 1549 | "A String", |
| 1550 | ], |
| 1551 | }, |
| 1552 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1553 | "expectedCommand": [ # This field contains the expected command used to perform the step. |
| 1554 | "A String", |
| 1555 | ], |
| 1556 | "signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata. |
| 1557 | { # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification. |
| 1558 | "keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256". |
| 1559 | "keyId": "A String", # key_id is an identifier for the signing key. |
| 1560 | "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa". |
| 1561 | "publicKeyValue": "A String", # This field contains the actual public key. |
| 1562 | }, |
| 1563 | ], |
| 1564 | "threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1565 | "stepName": "A String", # This field identifies the name of the step in the supply chain. |
| 1566 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1567 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 1568 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 1569 | "resourceUri": [ # Required. Resource URI for the artifact being deployed. |
| 1570 | "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1571 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1572 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1573 | "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. |
| 1574 | "name": "A String", # Required. Immutable. The name of the package. |
| 1575 | "distribution": [ # The various channels by which a package is distributed. |
| 1576 | { # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. |
| 1577 | "description": "A String", # The distribution channel-specific description of this package. |
| 1578 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 1579 | "url": "A String", # The distribution channel-specific homepage for this package. |
| 1580 | "latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel. |
| 1581 | "name": "A String", # Required only when version kind is NORMAL. The main part of the version name. |
| 1582 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| 1583 | "revision": "A String", # The iteration of the package build from the above version. |
| 1584 | "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions. |
| 1585 | }, |
| 1586 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. |
| 1587 | "cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 1588 | }, |
| 1589 | ], |
| 1590 | }, |
| 1591 | "name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1592 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1593 | </div> |
| 1594 | |
| 1595 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1596 | <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] | 1597 | <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. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1598 | |
| 1599 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1600 | 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] | 1601 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1602 | The object takes the form of: |
| 1603 | |
| 1604 | { # Request message for `SetIamPolicy` method. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1605 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1606 | "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). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1607 | "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] | 1608 | { # Associates `members` with a `role`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1609 | "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 | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1610 | "A String", |
| 1611 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1612 | "bindingId": "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1613 | "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). |
| 1614 | "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. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1615 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1616 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1617 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1618 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1619 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1620 | }, |
| 1621 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1622 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1623 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1624 | } |
| 1625 | |
| 1626 | x__xgafv: string, V1 error format. |
| 1627 | Allowed values |
| 1628 | 1 - v1 error format |
| 1629 | 2 - v2 error format |
| 1630 | |
| 1631 | Returns: |
| 1632 | An object of the form: |
| 1633 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1634 | { # 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/). |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1635 | "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). |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1636 | "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] | 1637 | { # Associates `members` with a `role`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1638 | "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 | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1639 | "A String", |
| 1640 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1641 | "bindingId": "A String", |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1642 | "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). |
| 1643 | "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. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1644 | "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. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1645 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1646 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1647 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1648 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1649 | }, |
| 1650 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1651 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1652 | }</pre> |
| 1653 | </div> |
| 1654 | |
| 1655 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1656 | <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] | 1657 | <pre>Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1658 | |
| 1659 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1660 | 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] | 1661 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1662 | The object takes the form of: |
| 1663 | |
| 1664 | { # Request message for `TestIamPermissions` method. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1665 | "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] | 1666 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1667 | ], |
| 1668 | } |
| 1669 | |
| 1670 | x__xgafv: string, V1 error format. |
| 1671 | Allowed values |
| 1672 | 1 - v1 error format |
| 1673 | 2 - v2 error format |
| 1674 | |
| 1675 | Returns: |
| 1676 | An object of the form: |
| 1677 | |
| 1678 | { # Response message for `TestIamPermissions` method. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1679 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1680 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1681 | ], |
| 1682 | }</pre> |
| 1683 | </div> |
| 1684 | |
| 1685 | </body></html> |