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