| 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.occurrences.html">occurrences</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(parent, body=None, name=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 82 | <p class="firstline">Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 85 | <p class="firstline">Deletes the given `Occurrence` from the system. Use this when an `Occurrence` is no longer applicable for the given resource.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Returns the requested `Occurrence`.</p> |
| 89 | <p class="toc_element"> |
| 90 | <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] | 91 | <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] | 92 | <p class="toc_element"> |
| 93 | <code><a href="#getNotes">getNotes(name, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Gets the `Note` attached to the given `Occurrence`.</p> |
| 95 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 96 | <code><a href="#getVulnerabilitySummary">getVulnerabilitySummary(parent, filter=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Gets a summary of the number and severity of occurrences.</p> |
| 98 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 99 | <code><a href="#list">list(parent, filter=None, kind=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] | 100 | <p class="firstline">Lists active `Occurrences` for a given project matching the filters.</p> |
| 101 | <p class="toc_element"> |
| 102 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 103 | <p class="firstline">Retrieves the next page of results.</p> |
| 104 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <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] | 106 | <p class="firstline">Updates an existing occurrence.</p> |
| 107 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | <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] | 109 | <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] | 110 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 111 | <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] | 112 | <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] | 113 | <h3>Method Details</h3> |
| 114 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 115 | <code class="details" id="close">close()</code> |
| 116 | <pre>Close httplib2 connections.</pre> |
| 117 | </div> |
| 118 | |
| 119 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 120 | <code class="details" id="create">create(parent, body=None, name=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 121 | <pre>Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | |
| 123 | Args: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | 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] | 125 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 126 | The object takes the form of: |
| 127 | |
| 128 | { # `Occurrence` includes information about analysis occurrences for an image. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 129 | "attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact. |
| 130 | "pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. |
| 131 | "contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). |
| 132 | "pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. |
| 133 | "signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. |
| 134 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 135 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 136 | "buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build. |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 137 | "intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 138 | "builderConfig": { # required |
| 139 | "id": "A String", |
| 140 | }, |
| 141 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 142 | "A String", |
| 143 | ], |
| 144 | "metadata": { # Other properties of the build. |
| 145 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 146 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 147 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 148 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 149 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 150 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 151 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 152 | }, |
| 153 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 154 | }, |
| 155 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 156 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 157 | { |
| 158 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 159 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 160 | ], |
| 161 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 162 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 163 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 164 | { |
| 165 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 166 | }, |
| 167 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 168 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 169 | }, |
| 170 | }, |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 171 | "intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope. |
| 172 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 173 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 174 | "provenance": { # provenance is a predicate of type intotoprovenance |
| 175 | "builderConfig": { # required |
| 176 | "id": "A String", |
| 177 | }, |
| 178 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 179 | "A String", |
| 180 | ], |
| 181 | "metadata": { # Other properties of the build. |
| 182 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 183 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 184 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 185 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 186 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 187 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 188 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 189 | }, |
| 190 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 191 | }, |
| 192 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 193 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| 194 | { |
| 195 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 196 | }, |
| 197 | ], |
| 198 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 199 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 200 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 201 | { |
| 202 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 203 | }, |
| 204 | ], |
| 205 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 206 | }, |
| 207 | }, |
| 208 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 209 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 210 | "id": "A String", # id is the id of the slsa provenance builder |
| 211 | }, |
| 212 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 213 | { # Material is a material used in the generation of the provenance |
| 214 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 215 | "a_key": "A String", |
| 216 | }, |
| 217 | "uri": "A String", # uri is the uri of the material |
| 218 | }, |
| 219 | ], |
| 220 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 221 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 222 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 223 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 224 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 225 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 226 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 227 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 228 | }, |
| 229 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 230 | }, |
| 231 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 232 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 233 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 234 | }, |
| 235 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 236 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 237 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 238 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 239 | }, |
| 240 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 241 | }, |
| 242 | }, |
| 243 | "subject": [ # subject is the subjects of the intoto statement |
| 244 | { # Subject refers to the subject of the intoto statement |
| 245 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| 246 | "a_key": "A String", |
| 247 | }, |
| 248 | "name": "A String", # name is the name of the Subject used here |
| 249 | }, |
| 250 | ], |
| 251 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 252 | "provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 253 | "buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. |
| 254 | "a_key": "A String", |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 255 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 256 | "builderVersion": "A String", # Version string of the builder at the time this build was executed. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 257 | "builtArtifacts": [ # Output of the build. |
| 258 | { # Artifact describes a build product. |
| 259 | "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 260 | "id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456 |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 261 | "name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 262 | "names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. |
| 263 | "A String", |
| 264 | ], |
| 265 | }, |
| 266 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 267 | "commands": [ # Commands requested by the build. |
| 268 | { # Command describes a step performed as part of the build pipeline. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 269 | "args": [ # Command-line arguments used when executing this Command. |
| 270 | "A String", |
| 271 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 272 | "dir": "A String", # Working directory (relative to project source root) used when running this Command. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 273 | "env": [ # Environment variables set before running this Command. |
| 274 | "A String", |
| 275 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 276 | "id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency. |
| 277 | "name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. |
| 278 | "waitFor": [ # The ID(s) of the Command(s) that this Command depends on. |
| 279 | "A String", |
| 280 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 281 | }, |
| 282 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 283 | "createTime": "A String", # Time at which the build was created. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 284 | "creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. |
| 285 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 286 | "id": "A String", # Unique identifier of the build. |
| 287 | "logsBucket": "A String", # Google Cloud Storage bucket where logs were written. |
| 288 | "projectId": "A String", # ID of the project. |
| 289 | "sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build. |
| 290 | "additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. |
| 291 | { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. |
| 292 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| 293 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 294 | "kind": "A String", # The alias kind. |
| 295 | "name": "A String", # The alias name. |
| 296 | }, |
| 297 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| 298 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 299 | "projectId": "A String", # The ID of the project. |
| 300 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 301 | }, |
| 302 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 303 | }, |
| 304 | "revisionId": "A String", # A revision ID. |
| 305 | }, |
| 306 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 307 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 308 | "kind": "A String", # The alias kind. |
| 309 | "name": "A String", # The alias name. |
| 310 | }, |
| 311 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| 312 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 313 | "revisionId": "A String", # A revision (commit) ID. |
| 314 | }, |
| 315 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 316 | "revisionId": "A String", # Required. Git commit hash. |
| 317 | "url": "A String", # Git repository URL. |
| 318 | }, |
| 319 | "labels": { # Labels with user defined metadata. |
| 320 | "a_key": "A String", |
| 321 | }, |
| 322 | }, |
| 323 | ], |
| 324 | "artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location. |
| 325 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 326 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 327 | "object": "A String", # Google Cloud Storage object containing source. |
| 328 | }, |
| 329 | "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location. |
| 330 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| 331 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 332 | "kind": "A String", # The alias kind. |
| 333 | "name": "A String", # The alias name. |
| 334 | }, |
| 335 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| 336 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 337 | "projectId": "A String", # The ID of the project. |
| 338 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 339 | }, |
| 340 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 341 | }, |
| 342 | "revisionId": "A String", # A revision ID. |
| 343 | }, |
| 344 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 345 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 346 | "kind": "A String", # The alias kind. |
| 347 | "name": "A String", # The alias name. |
| 348 | }, |
| 349 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| 350 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 351 | "revisionId": "A String", # A revision (commit) ID. |
| 352 | }, |
| 353 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 354 | "revisionId": "A String", # Required. Git commit hash. |
| 355 | "url": "A String", # Git repository URL. |
| 356 | }, |
| 357 | "labels": { # Labels with user defined metadata. |
| 358 | "a_key": "A String", |
| 359 | }, |
| 360 | }, |
| 361 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. |
| 362 | "a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build. |
| 363 | "fileHash": [ # Collection of file hashes. |
| 364 | { # Container message for hash values. |
| 365 | "type": "A String", # The type of hash that was performed. |
| 366 | "value": "A String", # The hash value. |
| 367 | }, |
| 368 | ], |
| 369 | }, |
| 370 | }, |
| 371 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo. |
| 372 | "branchName": "A String", # Name of the branch to build. |
| 373 | "commitSha": "A String", # Explicit commit SHA to build. |
| 374 | "projectId": "A String", # ID of the project that owns the repo. |
| 375 | "repoName": "A String", # Name of the repo. |
| 376 | "tagName": "A String", # Name of the tag to build. |
| 377 | }, |
| 378 | "storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage. |
| 379 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 380 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 381 | "object": "A String", # Google Cloud Storage object containing source. |
| 382 | }, |
| 383 | }, |
| 384 | "startTime": "A String", # Time at which execution of the build was started. |
| 385 | "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 386 | }, |
| 387 | "provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. |
| 388 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 389 | "compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes whether or not a resource passes compliance checks. |
| 390 | "nonComplianceReason": "A String", # The reason for non compliance of these files. |
| 391 | "nonCompliantFiles": [ # A list of files which are violating compliance checks. |
| 392 | { # Details about files that caused a compliance check to fail. |
| 393 | "displayCommand": "A String", # Command to display the non-compliant files. |
| 394 | "path": "A String", # display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'. Empty if `display_command` is set. |
| 395 | "reason": "A String", # Explains why a file is non compliant for a CIS check. |
| 396 | }, |
| 397 | ], |
| 398 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 399 | "createTime": "A String", # Output only. The time this `Occurrence` was created. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 400 | "deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 401 | "address": "A String", # Address of the runtime element hosting this deployment. |
| 402 | "config": "A String", # Configuration used to create this deployment. |
| 403 | "deployTime": "A String", # Beginning of the lifetime of this deployment. |
| 404 | "platform": "A String", # Platform hosting this deployment. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 405 | "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. |
| 406 | "A String", |
| 407 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 408 | "undeployTime": "A String", # End of the lifetime of this deployment. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 409 | "userEmail": "A String", # Identity of the user that triggered this deployment. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 410 | }, |
| 411 | "derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note. |
| 412 | "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence. |
| 413 | "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis. |
| 414 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 415 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 416 | "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| 417 | "A String", |
| 418 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 419 | "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] | 420 | }, |
| 421 | "layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. |
| 422 | { # Layer holds metadata specific to a layer of a Docker image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 423 | "arguments": "A String", # The recovered arguments to the Dockerfile directive. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 424 | "directive": "A String", # The recovered Dockerfile directive used to construct this layer. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 425 | }, |
| 426 | ], |
| 427 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 428 | "discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 429 | "analysisStatus": "A String", # The status of discovery for the resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 430 | "analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API. |
| 431 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 432 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 433 | { |
| 434 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 435 | }, |
| 436 | ], |
| 437 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 438 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 439 | "continuousAnalysis": "A String", # Whether the resource is continuously analyzed. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 440 | "cpe": "A String", # The CPE of the resource being scanned. |
| 441 | "operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. |
| 442 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 443 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 444 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 445 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 446 | { |
| 447 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 448 | }, |
| 449 | ], |
| 450 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 451 | }, |
| 452 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 453 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 454 | }, |
| 455 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 456 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 457 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 458 | }, |
| 459 | }, |
| 460 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 461 | "dsseAttestation": { # An occurrence describing an attestation on a resource # This represents a DSSE attestation occurrence |
| 462 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. |
| 463 | "payload": "A String", # The bytes being signed |
| 464 | "payloadType": "A String", # The type of payload being signed |
| 465 | "signatures": [ # The signatures over the payload |
| 466 | { # A DSSE signature |
| 467 | "keyid": "A String", # A reference id to the key being used for signing |
| 468 | "sig": "A String", # The signature itself |
| 469 | }, |
| 470 | ], |
| 471 | }, |
| 472 | "statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 473 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 474 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 475 | "provenance": { # provenance is a predicate of type intotoprovenance |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 476 | "builderConfig": { # required |
| 477 | "id": "A String", |
| 478 | }, |
| 479 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 480 | "A String", |
| 481 | ], |
| 482 | "metadata": { # Other properties of the build. |
| 483 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 484 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 485 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 486 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 487 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 488 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 489 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 490 | }, |
| 491 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 492 | }, |
| 493 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 494 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 495 | { |
| 496 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 497 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 498 | ], |
| 499 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 500 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 501 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 502 | { |
| 503 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 504 | }, |
| 505 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 506 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 507 | }, |
| 508 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 509 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 510 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 511 | "id": "A String", # id is the id of the slsa provenance builder |
| 512 | }, |
| 513 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 514 | { # Material is a material used in the generation of the provenance |
| 515 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 516 | "a_key": "A String", |
| 517 | }, |
| 518 | "uri": "A String", # uri is the uri of the material |
| 519 | }, |
| 520 | ], |
| 521 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 522 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 523 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 524 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 525 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 526 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 527 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 528 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 529 | }, |
| 530 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 531 | }, |
| 532 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 533 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 534 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 535 | }, |
| 536 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 537 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 538 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 539 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 540 | }, |
| 541 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 542 | }, |
| 543 | }, |
| 544 | "subject": [ # subject is the subjects of the intoto statement |
| 545 | { # Subject refers to the subject of the intoto statement |
| 546 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 547 | "a_key": "A String", |
| 548 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 549 | "name": "A String", # name is the name of the Subject used here |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 550 | }, |
| 551 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 552 | }, |
| 553 | }, |
| 554 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse |
| 555 | "payload": "A String", # The bytes being signed |
| 556 | "payloadType": "A String", # The type of payload being signed |
| 557 | "signatures": [ # The signatures over the payload |
| 558 | { # A DSSE signature |
| 559 | "keyid": "A String", # A reference id to the key being used for signing |
| 560 | "sig": "A String", # The signature itself |
| 561 | }, |
| 562 | ], |
| 563 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 564 | "installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource. |
| 565 | "location": [ # All of the places within the filesystem versions of this package have been found. |
| 566 | { # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status |
| 567 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 568 | "path": "A String", # The path from which we gathered that this package/version is installed. |
| 569 | "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 installed at this location. |
| 570 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 571 | "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] | 572 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 573 | "name": "A String", # The main part of the version name. |
| 574 | "revision": "A String", # The iteration of the package build from the above version. |
| 575 | }, |
| 576 | }, |
| 577 | ], |
| 578 | "name": "A String", # Output only. The name of the installed package. |
| 579 | }, |
| 580 | "kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests. |
| 581 | "name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" |
| 582 | "noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests. |
| 583 | "remediation": "A String", # A description of actions that can be taken to remedy the `Note` |
| 584 | "resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies. |
| 585 | "contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest. |
| 586 | "type": "A String", # The type of hash that was performed. |
| 587 | "value": "A String", # The hash value. |
| 588 | }, |
| 589 | "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian". |
| 590 | "uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image. |
| 591 | }, |
| 592 | "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 593 | "sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific software bill of materials document. |
| 594 | "createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard |
| 595 | "creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields |
| 596 | "creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name |
| 597 | "A String", |
| 598 | ], |
| 599 | "documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document |
| 600 | "externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document |
| 601 | "A String", |
| 602 | ], |
| 603 | "id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally |
| 604 | "licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created |
| 605 | "namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter |
| 606 | "title": "A String", # Identify name of this document as designated by creator |
| 607 | }, |
| 608 | "spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File. |
| 609 | "attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts |
| 610 | "A String", |
| 611 | ], |
| 612 | "comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file |
| 613 | "contributors": [ # This field provides a place for the SPDX file creator to record file contributors |
| 614 | "A String", |
| 615 | ], |
| 616 | "copyright": "A String", # Identify the copyright holder of the file, as well as any dates present |
| 617 | "filesLicenseInfo": [ # This field contains the license information actually found in the file, if any |
| 618 | "A String", |
| 619 | ], |
| 620 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 621 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined |
| 622 | "comments": "A String", # Comments |
| 623 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 624 | }, |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 625 | "notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file |
| 626 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 627 | "spdxPackage": { # PackageInfoOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 628 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described |
| 629 | "filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 630 | "homePage": "A String", # Output only. Provide a place for the SPDX file creator to record a web site that serves as the package's home page |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 631 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 632 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # package or alternative values, if the governing license cannot be determined |
| 633 | "comments": "A String", # Comments |
| 634 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 635 | }, |
| 636 | "packageType": "A String", # Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 637 | "sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 638 | "summaryDescription": "A String", # Output only. A short description of the package |
| 639 | "title": "A String", # Output only. Identify the full name of the package as given by the Package Originator |
| 640 | "version": "A String", # Output only. Identify the version of the package |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 641 | }, |
| 642 | "spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific relationship between SPDX elements. |
| 643 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship |
| 644 | "source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc) |
| 645 | "target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 646 | "type": "A String", # Output only. The type of relationship between the source and target SPDX elements |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 647 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 648 | "updateTime": "A String", # Output only. The time this `Occurrence` was last updated. |
| 649 | "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade. |
| 650 | "distribution": { # 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. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence. |
| 651 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 652 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 653 | "cve": [ # The cve that would be resolved by this upgrade. |
| 654 | "A String", |
| 655 | ], |
| 656 | "severity": "A String", # The severity as specified by the upstream operating system. |
| 657 | }, |
| 658 | "package": "A String", # Required - The package this Upgrade is for. |
| 659 | "parsedVersion": { # 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 a machine + human readable form. |
| 660 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 661 | "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] | 662 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 663 | "name": "A String", # The main part of the version name. |
| 664 | "revision": "A String", # The iteration of the package build from the above version. |
| 665 | }, |
| 666 | }, |
| 667 | "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note. |
| 668 | "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 669 | "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple package issues for this vulnerability, they can have different effective severities because some might come from the distro and some might come from installed language packs (e.g. Maven JARs or Go binaries). For this reason, it is advised to use the effective severity on the PackageIssue level, as this field may eventually be deprecated. In the case where multiple PackageIssues have different effective severities, the one set here will be the highest severity of any of the PackageIssues. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 670 | "packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource. |
| 671 | { # This message wraps a location affected by a vulnerability and its associated fix (if one is available). |
| 672 | "affectedLocation": { # The location of the vulnerability # The location of the vulnerability. |
| 673 | "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. |
| 674 | "package": "A String", # The package being described. |
| 675 | "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. |
| 676 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 677 | "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] | 678 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 679 | "name": "A String", # The main part of the version name. |
| 680 | "revision": "A String", # The iteration of the package build from the above version. |
| 681 | }, |
| 682 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 683 | "effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when distro or language system has not yet assigned a severity for this vulnerability. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 684 | "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability. |
| 685 | "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. |
| 686 | "package": "A String", # The package being described. |
| 687 | "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. |
| 688 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 689 | "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] | 690 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 691 | "name": "A String", # The main part of the version name. |
| 692 | "revision": "A String", # The iteration of the package build from the above version. |
| 693 | }, |
| 694 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 695 | "packageType": "A String", # The type of package (e.g. OS, MAVEN, GO). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 696 | "severityName": "A String", |
| 697 | }, |
| 698 | ], |
| 699 | "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 700 | "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). This may be deprecated in the future because we can have multiple PackageIssues with different package types. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 701 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 702 | } |
| 703 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 704 | name: string, The name of the project. Should be of the form "projects/{project_id}". @Deprecated |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 705 | x__xgafv: string, V1 error format. |
| 706 | Allowed values |
| 707 | 1 - v1 error format |
| 708 | 2 - v2 error format |
| 709 | |
| 710 | Returns: |
| 711 | An object of the form: |
| 712 | |
| 713 | { # `Occurrence` includes information about analysis occurrences for an image. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 714 | "attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact. |
| 715 | "pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. |
| 716 | "contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). |
| 717 | "pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. |
| 718 | "signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. |
| 719 | }, |
| 720 | }, |
| 721 | "buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build. |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 722 | "intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 723 | "builderConfig": { # required |
| 724 | "id": "A String", |
| 725 | }, |
| 726 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 727 | "A String", |
| 728 | ], |
| 729 | "metadata": { # Other properties of the build. |
| 730 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 731 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 732 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 733 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 734 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 735 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 736 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 737 | }, |
| 738 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 739 | }, |
| 740 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 741 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 742 | { |
| 743 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 744 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 745 | ], |
| 746 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 747 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 748 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 749 | { |
| 750 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 751 | }, |
| 752 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 753 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 754 | }, |
| 755 | }, |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 756 | "intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope. |
| 757 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 758 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 759 | "provenance": { # provenance is a predicate of type intotoprovenance |
| 760 | "builderConfig": { # required |
| 761 | "id": "A String", |
| 762 | }, |
| 763 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 764 | "A String", |
| 765 | ], |
| 766 | "metadata": { # Other properties of the build. |
| 767 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 768 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 769 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 770 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 771 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 772 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 773 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 774 | }, |
| 775 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 776 | }, |
| 777 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 778 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| 779 | { |
| 780 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 781 | }, |
| 782 | ], |
| 783 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 784 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 785 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 786 | { |
| 787 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 788 | }, |
| 789 | ], |
| 790 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 791 | }, |
| 792 | }, |
| 793 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 794 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 795 | "id": "A String", # id is the id of the slsa provenance builder |
| 796 | }, |
| 797 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 798 | { # Material is a material used in the generation of the provenance |
| 799 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 800 | "a_key": "A String", |
| 801 | }, |
| 802 | "uri": "A String", # uri is the uri of the material |
| 803 | }, |
| 804 | ], |
| 805 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 806 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 807 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 808 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 809 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 810 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 811 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 812 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 813 | }, |
| 814 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 815 | }, |
| 816 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 817 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 818 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 819 | }, |
| 820 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 821 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 822 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 823 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 824 | }, |
| 825 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 826 | }, |
| 827 | }, |
| 828 | "subject": [ # subject is the subjects of the intoto statement |
| 829 | { # Subject refers to the subject of the intoto statement |
| 830 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| 831 | "a_key": "A String", |
| 832 | }, |
| 833 | "name": "A String", # name is the name of the Subject used here |
| 834 | }, |
| 835 | ], |
| 836 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 837 | "provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance |
| 838 | "buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. |
| 839 | "a_key": "A String", |
| 840 | }, |
| 841 | "builderVersion": "A String", # Version string of the builder at the time this build was executed. |
| 842 | "builtArtifacts": [ # Output of the build. |
| 843 | { # Artifact describes a build product. |
| 844 | "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. |
| 845 | "id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456 |
| 846 | "name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto. |
| 847 | "names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. |
| 848 | "A String", |
| 849 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 850 | }, |
| 851 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 852 | "commands": [ # Commands requested by the build. |
| 853 | { # Command describes a step performed as part of the build pipeline. |
| 854 | "args": [ # Command-line arguments used when executing this Command. |
| 855 | "A String", |
| 856 | ], |
| 857 | "dir": "A String", # Working directory (relative to project source root) used when running this Command. |
| 858 | "env": [ # Environment variables set before running this Command. |
| 859 | "A String", |
| 860 | ], |
| 861 | "id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency. |
| 862 | "name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. |
| 863 | "waitFor": [ # The ID(s) of the Command(s) that this Command depends on. |
| 864 | "A String", |
| 865 | ], |
| 866 | }, |
| 867 | ], |
| 868 | "createTime": "A String", # Time at which the build was created. |
| 869 | "creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. |
| 870 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 871 | "id": "A String", # Unique identifier of the build. |
| 872 | "logsBucket": "A String", # Google Cloud Storage bucket where logs were written. |
| 873 | "projectId": "A String", # ID of the project. |
| 874 | "sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build. |
| 875 | "additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. |
| 876 | { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 877 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 878 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 879 | "kind": "A String", # The alias kind. |
| 880 | "name": "A String", # The alias name. |
| 881 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 882 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 883 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 884 | "projectId": "A String", # The ID of the project. |
| 885 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 886 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 887 | "uid": "A String", # A server-assigned, globally unique identifier. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 888 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 889 | "revisionId": "A String", # A revision ID. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 890 | }, |
| 891 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 892 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 893 | "kind": "A String", # The alias kind. |
| 894 | "name": "A String", # The alias name. |
| 895 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 896 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 897 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 898 | "revisionId": "A String", # A revision (commit) ID. |
| 899 | }, |
| 900 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 901 | "revisionId": "A String", # Required. Git commit hash. |
| 902 | "url": "A String", # Git repository URL. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 903 | }, |
| 904 | "labels": { # Labels with user defined metadata. |
| 905 | "a_key": "A String", |
| 906 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 907 | }, |
| 908 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 909 | "artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location. |
| 910 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 911 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 912 | "object": "A String", # Google Cloud Storage object containing source. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 913 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 914 | "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location. |
| 915 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| 916 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 917 | "kind": "A String", # The alias kind. |
| 918 | "name": "A String", # The alias name. |
| 919 | }, |
| 920 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| 921 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 922 | "projectId": "A String", # The ID of the project. |
| 923 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 924 | }, |
| 925 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 926 | }, |
| 927 | "revisionId": "A String", # A revision ID. |
| 928 | }, |
| 929 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 930 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 931 | "kind": "A String", # The alias kind. |
| 932 | "name": "A String", # The alias name. |
| 933 | }, |
| 934 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| 935 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 936 | "revisionId": "A String", # A revision (commit) ID. |
| 937 | }, |
| 938 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 939 | "revisionId": "A String", # Required. Git commit hash. |
| 940 | "url": "A String", # Git repository URL. |
| 941 | }, |
| 942 | "labels": { # Labels with user defined metadata. |
| 943 | "a_key": "A String", |
| 944 | }, |
| 945 | }, |
| 946 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. |
| 947 | "a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build. |
| 948 | "fileHash": [ # Collection of file hashes. |
| 949 | { # Container message for hash values. |
| 950 | "type": "A String", # The type of hash that was performed. |
| 951 | "value": "A String", # The hash value. |
| 952 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 953 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 954 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 955 | }, |
| 956 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo. |
| 957 | "branchName": "A String", # Name of the branch to build. |
| 958 | "commitSha": "A String", # Explicit commit SHA to build. |
| 959 | "projectId": "A String", # ID of the project that owns the repo. |
| 960 | "repoName": "A String", # Name of the repo. |
| 961 | "tagName": "A String", # Name of the tag to build. |
| 962 | }, |
| 963 | "storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage. |
| 964 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 965 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 966 | "object": "A String", # Google Cloud Storage object containing source. |
| 967 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 968 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 969 | "startTime": "A String", # Time at which execution of the build was started. |
| 970 | "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 971 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 972 | "provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. |
| 973 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 974 | "compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes whether or not a resource passes compliance checks. |
| 975 | "nonComplianceReason": "A String", # The reason for non compliance of these files. |
| 976 | "nonCompliantFiles": [ # A list of files which are violating compliance checks. |
| 977 | { # Details about files that caused a compliance check to fail. |
| 978 | "displayCommand": "A String", # Command to display the non-compliant files. |
| 979 | "path": "A String", # display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'. Empty if `display_command` is set. |
| 980 | "reason": "A String", # Explains why a file is non compliant for a CIS check. |
| 981 | }, |
| 982 | ], |
| 983 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 984 | "createTime": "A String", # Output only. The time this `Occurrence` was created. |
| 985 | "deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime. |
| 986 | "address": "A String", # Address of the runtime element hosting this deployment. |
| 987 | "config": "A String", # Configuration used to create this deployment. |
| 988 | "deployTime": "A String", # Beginning of the lifetime of this deployment. |
| 989 | "platform": "A String", # Platform hosting this deployment. |
| 990 | "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. |
| 991 | "A String", |
| 992 | ], |
| 993 | "undeployTime": "A String", # End of the lifetime of this deployment. |
| 994 | "userEmail": "A String", # Identity of the user that triggered this deployment. |
| 995 | }, |
| 996 | "derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note. |
| 997 | "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence. |
| 998 | "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis. |
| 999 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image. |
| 1000 | "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. |
| 1001 | "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] | 1002 | "A String", |
| 1003 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1004 | "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] | 1005 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1006 | "layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. |
| 1007 | { # Layer holds metadata specific to a layer of a Docker image. |
| 1008 | "arguments": "A String", # The recovered arguments to the Dockerfile directive. |
| 1009 | "directive": "A String", # The recovered Dockerfile directive used to construct this layer. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1010 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1011 | ], |
| 1012 | }, |
| 1013 | "discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource. |
| 1014 | "analysisStatus": "A String", # The status of discovery for the resource. |
| 1015 | "analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API. |
| 1016 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1017 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1018 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1019 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1020 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1021 | ], |
| 1022 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 1023 | }, |
| 1024 | "continuousAnalysis": "A String", # Whether the resource is continuously analyzed. |
| 1025 | "cpe": "A String", # The CPE of the resource being scanned. |
| 1026 | "operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. |
| 1027 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 1028 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1029 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1030 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1031 | { |
| 1032 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1033 | }, |
| 1034 | ], |
| 1035 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 1036 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1037 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 1038 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1039 | }, |
| 1040 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 1041 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 1042 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1043 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1044 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1045 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1046 | "dsseAttestation": { # An occurrence describing an attestation on a resource # This represents a DSSE attestation occurrence |
| 1047 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. |
| 1048 | "payload": "A String", # The bytes being signed |
| 1049 | "payloadType": "A String", # The type of payload being signed |
| 1050 | "signatures": [ # The signatures over the payload |
| 1051 | { # A DSSE signature |
| 1052 | "keyid": "A String", # A reference id to the key being used for signing |
| 1053 | "sig": "A String", # The signature itself |
| 1054 | }, |
| 1055 | ], |
| 1056 | }, |
| 1057 | "statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1058 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 1059 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 1060 | "provenance": { # provenance is a predicate of type intotoprovenance |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1061 | "builderConfig": { # required |
| 1062 | "id": "A String", |
| 1063 | }, |
| 1064 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 1065 | "A String", |
| 1066 | ], |
| 1067 | "metadata": { # Other properties of the build. |
| 1068 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 1069 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 1070 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 1071 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 1072 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 1073 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 1074 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 1075 | }, |
| 1076 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 1077 | }, |
| 1078 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 1079 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 1080 | { |
| 1081 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1082 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1083 | ], |
| 1084 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 1085 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 1086 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 1087 | { |
| 1088 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1089 | }, |
| 1090 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1091 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 1092 | }, |
| 1093 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1094 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 1095 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 1096 | "id": "A String", # id is the id of the slsa provenance builder |
| 1097 | }, |
| 1098 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 1099 | { # Material is a material used in the generation of the provenance |
| 1100 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 1101 | "a_key": "A String", |
| 1102 | }, |
| 1103 | "uri": "A String", # uri is the uri of the material |
| 1104 | }, |
| 1105 | ], |
| 1106 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 1107 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 1108 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 1109 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 1110 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 1111 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 1112 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 1113 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 1114 | }, |
| 1115 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 1116 | }, |
| 1117 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 1118 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 1119 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1120 | }, |
| 1121 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 1122 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 1123 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 1124 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1125 | }, |
| 1126 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 1127 | }, |
| 1128 | }, |
| 1129 | "subject": [ # subject is the subjects of the intoto statement |
| 1130 | { # Subject refers to the subject of the intoto statement |
| 1131 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1132 | "a_key": "A String", |
| 1133 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1134 | "name": "A String", # name is the name of the Subject used here |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1135 | }, |
| 1136 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1137 | }, |
| 1138 | }, |
| 1139 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse |
| 1140 | "payload": "A String", # The bytes being signed |
| 1141 | "payloadType": "A String", # The type of payload being signed |
| 1142 | "signatures": [ # The signatures over the payload |
| 1143 | { # A DSSE signature |
| 1144 | "keyid": "A String", # A reference id to the key being used for signing |
| 1145 | "sig": "A String", # The signature itself |
| 1146 | }, |
| 1147 | ], |
| 1148 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1149 | "installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource. |
| 1150 | "location": [ # All of the places within the filesystem versions of this package have been found. |
| 1151 | { # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status |
| 1152 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 1153 | "path": "A String", # The path from which we gathered that this package/version is installed. |
| 1154 | "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 installed at this location. |
| 1155 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1156 | "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] | 1157 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 1158 | "name": "A String", # The main part of the version name. |
| 1159 | "revision": "A String", # The iteration of the package build from the above version. |
| 1160 | }, |
| 1161 | }, |
| 1162 | ], |
| 1163 | "name": "A String", # Output only. The name of the installed package. |
| 1164 | }, |
| 1165 | "kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests. |
| 1166 | "name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" |
| 1167 | "noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests. |
| 1168 | "remediation": "A String", # A description of actions that can be taken to remedy the `Note` |
| 1169 | "resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies. |
| 1170 | "contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest. |
| 1171 | "type": "A String", # The type of hash that was performed. |
| 1172 | "value": "A String", # The hash value. |
| 1173 | }, |
| 1174 | "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian". |
| 1175 | "uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image. |
| 1176 | }, |
| 1177 | "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1178 | "sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific software bill of materials document. |
| 1179 | "createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard |
| 1180 | "creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields |
| 1181 | "creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name |
| 1182 | "A String", |
| 1183 | ], |
| 1184 | "documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document |
| 1185 | "externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document |
| 1186 | "A String", |
| 1187 | ], |
| 1188 | "id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally |
| 1189 | "licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created |
| 1190 | "namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter |
| 1191 | "title": "A String", # Identify name of this document as designated by creator |
| 1192 | }, |
| 1193 | "spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File. |
| 1194 | "attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts |
| 1195 | "A String", |
| 1196 | ], |
| 1197 | "comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file |
| 1198 | "contributors": [ # This field provides a place for the SPDX file creator to record file contributors |
| 1199 | "A String", |
| 1200 | ], |
| 1201 | "copyright": "A String", # Identify the copyright holder of the file, as well as any dates present |
| 1202 | "filesLicenseInfo": [ # This field contains the license information actually found in the file, if any |
| 1203 | "A String", |
| 1204 | ], |
| 1205 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1206 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined |
| 1207 | "comments": "A String", # Comments |
| 1208 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 1209 | }, |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1210 | "notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file |
| 1211 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1212 | "spdxPackage": { # PackageInfoOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1213 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described |
| 1214 | "filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1215 | "homePage": "A String", # Output only. Provide a place for the SPDX file creator to record a web site that serves as the package's home page |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1216 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1217 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # package or alternative values, if the governing license cannot be determined |
| 1218 | "comments": "A String", # Comments |
| 1219 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 1220 | }, |
| 1221 | "packageType": "A String", # Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1222 | "sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1223 | "summaryDescription": "A String", # Output only. A short description of the package |
| 1224 | "title": "A String", # Output only. Identify the full name of the package as given by the Package Originator |
| 1225 | "version": "A String", # Output only. Identify the version of the package |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1226 | }, |
| 1227 | "spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific relationship between SPDX elements. |
| 1228 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship |
| 1229 | "source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc) |
| 1230 | "target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1231 | "type": "A String", # Output only. The type of relationship between the source and target SPDX elements |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1232 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1233 | "updateTime": "A String", # Output only. The time this `Occurrence` was last updated. |
| 1234 | "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade. |
| 1235 | "distribution": { # 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. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence. |
| 1236 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 1237 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 1238 | "cve": [ # The cve that would be resolved by this upgrade. |
| 1239 | "A String", |
| 1240 | ], |
| 1241 | "severity": "A String", # The severity as specified by the upstream operating system. |
| 1242 | }, |
| 1243 | "package": "A String", # Required - The package this Upgrade is for. |
| 1244 | "parsedVersion": { # 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 a machine + human readable form. |
| 1245 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1246 | "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] | 1247 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 1248 | "name": "A String", # The main part of the version name. |
| 1249 | "revision": "A String", # The iteration of the package build from the above version. |
| 1250 | }, |
| 1251 | }, |
| 1252 | "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note. |
| 1253 | "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1254 | "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple package issues for this vulnerability, they can have different effective severities because some might come from the distro and some might come from installed language packs (e.g. Maven JARs or Go binaries). For this reason, it is advised to use the effective severity on the PackageIssue level, as this field may eventually be deprecated. In the case where multiple PackageIssues have different effective severities, the one set here will be the highest severity of any of the PackageIssues. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1255 | "packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource. |
| 1256 | { # This message wraps a location affected by a vulnerability and its associated fix (if one is available). |
| 1257 | "affectedLocation": { # The location of the vulnerability # The location of the vulnerability. |
| 1258 | "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. |
| 1259 | "package": "A String", # The package being described. |
| 1260 | "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. |
| 1261 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1262 | "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] | 1263 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 1264 | "name": "A String", # The main part of the version name. |
| 1265 | "revision": "A String", # The iteration of the package build from the above version. |
| 1266 | }, |
| 1267 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1268 | "effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when distro or language system has not yet assigned a severity for this vulnerability. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1269 | "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability. |
| 1270 | "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. |
| 1271 | "package": "A String", # The package being described. |
| 1272 | "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. |
| 1273 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1274 | "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] | 1275 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 1276 | "name": "A String", # The main part of the version name. |
| 1277 | "revision": "A String", # The iteration of the package build from the above version. |
| 1278 | }, |
| 1279 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1280 | "packageType": "A String", # The type of package (e.g. OS, MAVEN, GO). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1281 | "severityName": "A String", |
| 1282 | }, |
| 1283 | ], |
| 1284 | "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1285 | "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). This may be deprecated in the future because we can have multiple PackageIssues with different package types. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1286 | }, |
| 1287 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1288 | </div> |
| 1289 | |
| 1290 | <div class="method"> |
| 1291 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1292 | <pre>Deletes the given `Occurrence` from the system. Use this when an `Occurrence` is no longer applicable for the given resource. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1293 | |
| 1294 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1295 | name: string, The name of the occurrence in the form of "projects/{project_id}/occurrences/{OCCURRENCE_ID}" (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1296 | x__xgafv: string, V1 error format. |
| 1297 | Allowed values |
| 1298 | 1 - v1 error format |
| 1299 | 2 - v2 error format |
| 1300 | |
| 1301 | Returns: |
| 1302 | An object of the form: |
| 1303 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1304 | { # 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] | 1305 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1306 | </div> |
| 1307 | |
| 1308 | <div class="method"> |
| 1309 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 1310 | <pre>Returns the requested `Occurrence`. |
| 1311 | |
| 1312 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1313 | name: string, The name of the occurrence of the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1314 | x__xgafv: string, V1 error format. |
| 1315 | Allowed values |
| 1316 | 1 - v1 error format |
| 1317 | 2 - v2 error format |
| 1318 | |
| 1319 | Returns: |
| 1320 | An object of the form: |
| 1321 | |
| 1322 | { # `Occurrence` includes information about analysis occurrences for an image. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1323 | "attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact. |
| 1324 | "pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. |
| 1325 | "contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). |
| 1326 | "pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. |
| 1327 | "signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. |
| 1328 | }, |
| 1329 | }, |
| 1330 | "buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build. |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 1331 | "intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1332 | "builderConfig": { # required |
| 1333 | "id": "A String", |
| 1334 | }, |
| 1335 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 1336 | "A String", |
| 1337 | ], |
| 1338 | "metadata": { # Other properties of the build. |
| 1339 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 1340 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 1341 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 1342 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 1343 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 1344 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 1345 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 1346 | }, |
| 1347 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 1348 | }, |
| 1349 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 1350 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 1351 | { |
| 1352 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1353 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1354 | ], |
| 1355 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 1356 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 1357 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 1358 | { |
| 1359 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1360 | }, |
| 1361 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1362 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 1363 | }, |
| 1364 | }, |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 1365 | "intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope. |
| 1366 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 1367 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 1368 | "provenance": { # provenance is a predicate of type intotoprovenance |
| 1369 | "builderConfig": { # required |
| 1370 | "id": "A String", |
| 1371 | }, |
| 1372 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 1373 | "A String", |
| 1374 | ], |
| 1375 | "metadata": { # Other properties of the build. |
| 1376 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 1377 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 1378 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 1379 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 1380 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 1381 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 1382 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 1383 | }, |
| 1384 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 1385 | }, |
| 1386 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 1387 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| 1388 | { |
| 1389 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1390 | }, |
| 1391 | ], |
| 1392 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 1393 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 1394 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 1395 | { |
| 1396 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1397 | }, |
| 1398 | ], |
| 1399 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 1400 | }, |
| 1401 | }, |
| 1402 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 1403 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 1404 | "id": "A String", # id is the id of the slsa provenance builder |
| 1405 | }, |
| 1406 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 1407 | { # Material is a material used in the generation of the provenance |
| 1408 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 1409 | "a_key": "A String", |
| 1410 | }, |
| 1411 | "uri": "A String", # uri is the uri of the material |
| 1412 | }, |
| 1413 | ], |
| 1414 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 1415 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 1416 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 1417 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 1418 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 1419 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 1420 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 1421 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 1422 | }, |
| 1423 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 1424 | }, |
| 1425 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 1426 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 1427 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1428 | }, |
| 1429 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 1430 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 1431 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 1432 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1433 | }, |
| 1434 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 1435 | }, |
| 1436 | }, |
| 1437 | "subject": [ # subject is the subjects of the intoto statement |
| 1438 | { # Subject refers to the subject of the intoto statement |
| 1439 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| 1440 | "a_key": "A String", |
| 1441 | }, |
| 1442 | "name": "A String", # name is the name of the Subject used here |
| 1443 | }, |
| 1444 | ], |
| 1445 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1446 | "provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance |
| 1447 | "buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. |
| 1448 | "a_key": "A String", |
| 1449 | }, |
| 1450 | "builderVersion": "A String", # Version string of the builder at the time this build was executed. |
| 1451 | "builtArtifacts": [ # Output of the build. |
| 1452 | { # Artifact describes a build product. |
| 1453 | "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. |
| 1454 | "id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456 |
| 1455 | "name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto. |
| 1456 | "names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. |
| 1457 | "A String", |
| 1458 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1459 | }, |
| 1460 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1461 | "commands": [ # Commands requested by the build. |
| 1462 | { # Command describes a step performed as part of the build pipeline. |
| 1463 | "args": [ # Command-line arguments used when executing this Command. |
| 1464 | "A String", |
| 1465 | ], |
| 1466 | "dir": "A String", # Working directory (relative to project source root) used when running this Command. |
| 1467 | "env": [ # Environment variables set before running this Command. |
| 1468 | "A String", |
| 1469 | ], |
| 1470 | "id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency. |
| 1471 | "name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. |
| 1472 | "waitFor": [ # The ID(s) of the Command(s) that this Command depends on. |
| 1473 | "A String", |
| 1474 | ], |
| 1475 | }, |
| 1476 | ], |
| 1477 | "createTime": "A String", # Time at which the build was created. |
| 1478 | "creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. |
| 1479 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 1480 | "id": "A String", # Unique identifier of the build. |
| 1481 | "logsBucket": "A String", # Google Cloud Storage bucket where logs were written. |
| 1482 | "projectId": "A String", # ID of the project. |
| 1483 | "sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build. |
| 1484 | "additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. |
| 1485 | { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1486 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1487 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 1488 | "kind": "A String", # The alias kind. |
| 1489 | "name": "A String", # The alias name. |
| 1490 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1491 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1492 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 1493 | "projectId": "A String", # The ID of the project. |
| 1494 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 1495 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1496 | "uid": "A String", # A server-assigned, globally unique identifier. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1497 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1498 | "revisionId": "A String", # A revision ID. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1499 | }, |
| 1500 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1501 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 1502 | "kind": "A String", # The alias kind. |
| 1503 | "name": "A String", # The alias name. |
| 1504 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1505 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1506 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 1507 | "revisionId": "A String", # A revision (commit) ID. |
| 1508 | }, |
| 1509 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 1510 | "revisionId": "A String", # Required. Git commit hash. |
| 1511 | "url": "A String", # Git repository URL. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1512 | }, |
| 1513 | "labels": { # Labels with user defined metadata. |
| 1514 | "a_key": "A String", |
| 1515 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1516 | }, |
| 1517 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1518 | "artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location. |
| 1519 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1520 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 1521 | "object": "A String", # Google Cloud Storage object containing source. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1522 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1523 | "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location. |
| 1524 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| 1525 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 1526 | "kind": "A String", # The alias kind. |
| 1527 | "name": "A String", # The alias name. |
| 1528 | }, |
| 1529 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| 1530 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 1531 | "projectId": "A String", # The ID of the project. |
| 1532 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 1533 | }, |
| 1534 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 1535 | }, |
| 1536 | "revisionId": "A String", # A revision ID. |
| 1537 | }, |
| 1538 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 1539 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 1540 | "kind": "A String", # The alias kind. |
| 1541 | "name": "A String", # The alias name. |
| 1542 | }, |
| 1543 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| 1544 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 1545 | "revisionId": "A String", # A revision (commit) ID. |
| 1546 | }, |
| 1547 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 1548 | "revisionId": "A String", # Required. Git commit hash. |
| 1549 | "url": "A String", # Git repository URL. |
| 1550 | }, |
| 1551 | "labels": { # Labels with user defined metadata. |
| 1552 | "a_key": "A String", |
| 1553 | }, |
| 1554 | }, |
| 1555 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. |
| 1556 | "a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build. |
| 1557 | "fileHash": [ # Collection of file hashes. |
| 1558 | { # Container message for hash values. |
| 1559 | "type": "A String", # The type of hash that was performed. |
| 1560 | "value": "A String", # The hash value. |
| 1561 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1562 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1563 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1564 | }, |
| 1565 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo. |
| 1566 | "branchName": "A String", # Name of the branch to build. |
| 1567 | "commitSha": "A String", # Explicit commit SHA to build. |
| 1568 | "projectId": "A String", # ID of the project that owns the repo. |
| 1569 | "repoName": "A String", # Name of the repo. |
| 1570 | "tagName": "A String", # Name of the tag to build. |
| 1571 | }, |
| 1572 | "storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage. |
| 1573 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 1574 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 1575 | "object": "A String", # Google Cloud Storage object containing source. |
| 1576 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1577 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1578 | "startTime": "A String", # Time at which execution of the build was started. |
| 1579 | "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1580 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1581 | "provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. |
| 1582 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 1583 | "compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes whether or not a resource passes compliance checks. |
| 1584 | "nonComplianceReason": "A String", # The reason for non compliance of these files. |
| 1585 | "nonCompliantFiles": [ # A list of files which are violating compliance checks. |
| 1586 | { # Details about files that caused a compliance check to fail. |
| 1587 | "displayCommand": "A String", # Command to display the non-compliant files. |
| 1588 | "path": "A String", # display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'. Empty if `display_command` is set. |
| 1589 | "reason": "A String", # Explains why a file is non compliant for a CIS check. |
| 1590 | }, |
| 1591 | ], |
| 1592 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1593 | "createTime": "A String", # Output only. The time this `Occurrence` was created. |
| 1594 | "deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime. |
| 1595 | "address": "A String", # Address of the runtime element hosting this deployment. |
| 1596 | "config": "A String", # Configuration used to create this deployment. |
| 1597 | "deployTime": "A String", # Beginning of the lifetime of this deployment. |
| 1598 | "platform": "A String", # Platform hosting this deployment. |
| 1599 | "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. |
| 1600 | "A String", |
| 1601 | ], |
| 1602 | "undeployTime": "A String", # End of the lifetime of this deployment. |
| 1603 | "userEmail": "A String", # Identity of the user that triggered this deployment. |
| 1604 | }, |
| 1605 | "derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note. |
| 1606 | "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence. |
| 1607 | "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis. |
| 1608 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image. |
| 1609 | "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. |
| 1610 | "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] | 1611 | "A String", |
| 1612 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1613 | "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] | 1614 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1615 | "layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. |
| 1616 | { # Layer holds metadata specific to a layer of a Docker image. |
| 1617 | "arguments": "A String", # The recovered arguments to the Dockerfile directive. |
| 1618 | "directive": "A String", # The recovered Dockerfile directive used to construct this layer. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1619 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1620 | ], |
| 1621 | }, |
| 1622 | "discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource. |
| 1623 | "analysisStatus": "A String", # The status of discovery for the resource. |
| 1624 | "analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API. |
| 1625 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1626 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1627 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1628 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1629 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1630 | ], |
| 1631 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 1632 | }, |
| 1633 | "continuousAnalysis": "A String", # Whether the resource is continuously analyzed. |
| 1634 | "cpe": "A String", # The CPE of the resource being scanned. |
| 1635 | "operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. |
| 1636 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 1637 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1638 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 1639 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 1640 | { |
| 1641 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1642 | }, |
| 1643 | ], |
| 1644 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 1645 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1646 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 1647 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1648 | }, |
| 1649 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 1650 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 1651 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1652 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1653 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1654 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1655 | "dsseAttestation": { # An occurrence describing an attestation on a resource # This represents a DSSE attestation occurrence |
| 1656 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. |
| 1657 | "payload": "A String", # The bytes being signed |
| 1658 | "payloadType": "A String", # The type of payload being signed |
| 1659 | "signatures": [ # The signatures over the payload |
| 1660 | { # A DSSE signature |
| 1661 | "keyid": "A String", # A reference id to the key being used for signing |
| 1662 | "sig": "A String", # The signature itself |
| 1663 | }, |
| 1664 | ], |
| 1665 | }, |
| 1666 | "statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1667 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 1668 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 1669 | "provenance": { # provenance is a predicate of type intotoprovenance |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1670 | "builderConfig": { # required |
| 1671 | "id": "A String", |
| 1672 | }, |
| 1673 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 1674 | "A String", |
| 1675 | ], |
| 1676 | "metadata": { # Other properties of the build. |
| 1677 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 1678 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 1679 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 1680 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 1681 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 1682 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 1683 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 1684 | }, |
| 1685 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 1686 | }, |
| 1687 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 1688 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 1689 | { |
| 1690 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1691 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1692 | ], |
| 1693 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 1694 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 1695 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 1696 | { |
| 1697 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1698 | }, |
| 1699 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1700 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 1701 | }, |
| 1702 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1703 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 1704 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 1705 | "id": "A String", # id is the id of the slsa provenance builder |
| 1706 | }, |
| 1707 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 1708 | { # Material is a material used in the generation of the provenance |
| 1709 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 1710 | "a_key": "A String", |
| 1711 | }, |
| 1712 | "uri": "A String", # uri is the uri of the material |
| 1713 | }, |
| 1714 | ], |
| 1715 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 1716 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 1717 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 1718 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 1719 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 1720 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 1721 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 1722 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 1723 | }, |
| 1724 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 1725 | }, |
| 1726 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 1727 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 1728 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1729 | }, |
| 1730 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 1731 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 1732 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 1733 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1734 | }, |
| 1735 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 1736 | }, |
| 1737 | }, |
| 1738 | "subject": [ # subject is the subjects of the intoto statement |
| 1739 | { # Subject refers to the subject of the intoto statement |
| 1740 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1741 | "a_key": "A String", |
| 1742 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1743 | "name": "A String", # name is the name of the Subject used here |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1744 | }, |
| 1745 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 1746 | }, |
| 1747 | }, |
| 1748 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse |
| 1749 | "payload": "A String", # The bytes being signed |
| 1750 | "payloadType": "A String", # The type of payload being signed |
| 1751 | "signatures": [ # The signatures over the payload |
| 1752 | { # A DSSE signature |
| 1753 | "keyid": "A String", # A reference id to the key being used for signing |
| 1754 | "sig": "A String", # The signature itself |
| 1755 | }, |
| 1756 | ], |
| 1757 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1758 | "installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource. |
| 1759 | "location": [ # All of the places within the filesystem versions of this package have been found. |
| 1760 | { # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status |
| 1761 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 1762 | "path": "A String", # The path from which we gathered that this package/version is installed. |
| 1763 | "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 installed at this location. |
| 1764 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1765 | "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] | 1766 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 1767 | "name": "A String", # The main part of the version name. |
| 1768 | "revision": "A String", # The iteration of the package build from the above version. |
| 1769 | }, |
| 1770 | }, |
| 1771 | ], |
| 1772 | "name": "A String", # Output only. The name of the installed package. |
| 1773 | }, |
| 1774 | "kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests. |
| 1775 | "name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" |
| 1776 | "noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests. |
| 1777 | "remediation": "A String", # A description of actions that can be taken to remedy the `Note` |
| 1778 | "resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies. |
| 1779 | "contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest. |
| 1780 | "type": "A String", # The type of hash that was performed. |
| 1781 | "value": "A String", # The hash value. |
| 1782 | }, |
| 1783 | "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian". |
| 1784 | "uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image. |
| 1785 | }, |
| 1786 | "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1787 | "sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific software bill of materials document. |
| 1788 | "createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard |
| 1789 | "creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields |
| 1790 | "creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name |
| 1791 | "A String", |
| 1792 | ], |
| 1793 | "documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document |
| 1794 | "externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document |
| 1795 | "A String", |
| 1796 | ], |
| 1797 | "id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally |
| 1798 | "licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created |
| 1799 | "namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter |
| 1800 | "title": "A String", # Identify name of this document as designated by creator |
| 1801 | }, |
| 1802 | "spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File. |
| 1803 | "attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts |
| 1804 | "A String", |
| 1805 | ], |
| 1806 | "comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file |
| 1807 | "contributors": [ # This field provides a place for the SPDX file creator to record file contributors |
| 1808 | "A String", |
| 1809 | ], |
| 1810 | "copyright": "A String", # Identify the copyright holder of the file, as well as any dates present |
| 1811 | "filesLicenseInfo": [ # This field contains the license information actually found in the file, if any |
| 1812 | "A String", |
| 1813 | ], |
| 1814 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1815 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined |
| 1816 | "comments": "A String", # Comments |
| 1817 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 1818 | }, |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1819 | "notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file |
| 1820 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1821 | "spdxPackage": { # PackageInfoOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1822 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described |
| 1823 | "filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1824 | "homePage": "A String", # Output only. Provide a place for the SPDX file creator to record a web site that serves as the package's home page |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1825 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1826 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # package or alternative values, if the governing license cannot be determined |
| 1827 | "comments": "A String", # Comments |
| 1828 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 1829 | }, |
| 1830 | "packageType": "A String", # Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1831 | "sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1832 | "summaryDescription": "A String", # Output only. A short description of the package |
| 1833 | "title": "A String", # Output only. Identify the full name of the package as given by the Package Originator |
| 1834 | "version": "A String", # Output only. Identify the version of the package |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1835 | }, |
| 1836 | "spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific relationship between SPDX elements. |
| 1837 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship |
| 1838 | "source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc) |
| 1839 | "target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1840 | "type": "A String", # Output only. The type of relationship between the source and target SPDX elements |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 1841 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1842 | "updateTime": "A String", # Output only. The time this `Occurrence` was last updated. |
| 1843 | "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade. |
| 1844 | "distribution": { # 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. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence. |
| 1845 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 1846 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 1847 | "cve": [ # The cve that would be resolved by this upgrade. |
| 1848 | "A String", |
| 1849 | ], |
| 1850 | "severity": "A String", # The severity as specified by the upstream operating system. |
| 1851 | }, |
| 1852 | "package": "A String", # Required - The package this Upgrade is for. |
| 1853 | "parsedVersion": { # 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 a machine + human readable form. |
| 1854 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1855 | "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] | 1856 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 1857 | "name": "A String", # The main part of the version name. |
| 1858 | "revision": "A String", # The iteration of the package build from the above version. |
| 1859 | }, |
| 1860 | }, |
| 1861 | "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note. |
| 1862 | "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1863 | "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple package issues for this vulnerability, they can have different effective severities because some might come from the distro and some might come from installed language packs (e.g. Maven JARs or Go binaries). For this reason, it is advised to use the effective severity on the PackageIssue level, as this field may eventually be deprecated. In the case where multiple PackageIssues have different effective severities, the one set here will be the highest severity of any of the PackageIssues. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1864 | "packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource. |
| 1865 | { # This message wraps a location affected by a vulnerability and its associated fix (if one is available). |
| 1866 | "affectedLocation": { # The location of the vulnerability # The location of the vulnerability. |
| 1867 | "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. |
| 1868 | "package": "A String", # The package being described. |
| 1869 | "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. |
| 1870 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1871 | "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] | 1872 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 1873 | "name": "A String", # The main part of the version name. |
| 1874 | "revision": "A String", # The iteration of the package build from the above version. |
| 1875 | }, |
| 1876 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1877 | "effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when distro or language system has not yet assigned a severity for this vulnerability. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1878 | "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability. |
| 1879 | "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. |
| 1880 | "package": "A String", # The package being described. |
| 1881 | "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. |
| 1882 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1883 | "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] | 1884 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 1885 | "name": "A String", # The main part of the version name. |
| 1886 | "revision": "A String", # The iteration of the package build from the above version. |
| 1887 | }, |
| 1888 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1889 | "packageType": "A String", # The type of package (e.g. OS, MAVEN, GO). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1890 | "severityName": "A String", |
| 1891 | }, |
| 1892 | ], |
| 1893 | "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 1894 | "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). This may be deprecated in the future because we can have multiple PackageIssues with different package types. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1895 | }, |
| 1896 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1897 | </div> |
| 1898 | |
| 1899 | <div class="method"> |
| 1900 | <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] | 1901 | <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] | 1902 | |
| 1903 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1904 | 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] | 1905 | body: object, The request body. |
| 1906 | The object takes the form of: |
| 1907 | |
| 1908 | { # Request message for `GetIamPolicy` method. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1909 | "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 1910 | "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1911 | }, |
| 1912 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1913 | |
| 1914 | x__xgafv: string, V1 error format. |
| 1915 | Allowed values |
| 1916 | 1 - v1 error format |
| 1917 | 2 - v2 error format |
| 1918 | |
| 1919 | Returns: |
| 1920 | An object of the form: |
| 1921 | |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1922 | { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| 1923 | "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. |
| 1924 | { # Associates `members`, or principals, with a `role`. |
| 1925 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1926 | "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. |
| 1927 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1928 | "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. |
| 1929 | "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] | 1930 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1931 | "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1932 | "A String", |
| 1933 | ], |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 1934 | "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1935 | }, |
| 1936 | ], |
| 1937 | "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. |
| 1938 | "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). |
| 1939 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1940 | </div> |
| 1941 | |
| 1942 | <div class="method"> |
| 1943 | <code class="details" id="getNotes">getNotes(name, x__xgafv=None)</code> |
| 1944 | <pre>Gets the `Note` attached to the given `Occurrence`. |
| 1945 | |
| 1946 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1947 | name: string, The name of the occurrence in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1948 | x__xgafv: string, V1 error format. |
| 1949 | Allowed values |
| 1950 | 1 - v1 error format |
| 1951 | 2 - v2 error format |
| 1952 | |
| 1953 | Returns: |
| 1954 | An object of the form: |
| 1955 | |
| 1956 | { # Provides a detailed description of a `Note`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1957 | "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. |
| 1958 | "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. |
| 1959 | "humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa". |
| 1960 | }, |
| 1961 | }, |
| 1962 | "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. |
| 1963 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image. |
| 1964 | "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. |
| 1965 | "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| 1966 | "A String", |
| 1967 | ], |
| 1968 | "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. |
| 1969 | }, |
| 1970 | "resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images. |
| 1971 | }, |
| 1972 | "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. |
| 1973 | "builderVersion": "A String", # Version of the builder which produced this Note. |
| 1974 | "signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`. |
| 1975 | "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). |
| 1976 | "keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id` |
| 1977 | "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` |
| 1978 | "signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string. |
| 1979 | }, |
| 1980 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 1981 | "compliance": { # ComplianceNote encapsulates all information about a specific compliance check. # A note describing a compliance check. |
| 1982 | "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. |
| 1983 | "profileLevel": 42, # The profile level of this CIS benchmark check. |
| 1984 | "severity": "A String", # The severity level of this CIS benchmark check. |
| 1985 | }, |
| 1986 | "description": "A String", # A description about this compliance check. |
| 1987 | "rationale": "A String", # A rationale for the existence of this compliance check. |
| 1988 | "remediation": "A String", # A description of remediation steps if the compliance check fails. |
| 1989 | "scanInstructions": "A String", # Serialized scan instructions with a predefined format. |
| 1990 | "title": "A String", # The title that identifies this compliance check. |
| 1991 | "version": [ # The OS and config versions the benchmark applies to. |
| 1992 | { # Describes the CIS benchmark version that is applicable to a given OS and os version. |
| 1993 | "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. |
| 1994 | "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. |
| 1995 | }, |
| 1996 | ], |
| 1997 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1998 | "createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests. |
| 1999 | "deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed. |
| 2000 | "resourceUri": [ # Resource URI for the artifact being deployed. |
| 2001 | "A String", |
| 2002 | ], |
| 2003 | }, |
| 2004 | "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. |
| 2005 | "analysisKind": "A String", # The kind of analysis that is handled by this discovery. |
| 2006 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2007 | "dsseAttestation": { # A note describing an attestation # A note describing a dsse attestation note. |
| 2008 | "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. |
| 2009 | "humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod". |
| 2010 | }, |
| 2011 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2012 | "expirationTime": "A String", # Time of expiration for this note, null if note does not expire. |
| 2013 | "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. |
| 2014 | "longDescription": "A String", # A detailed description of this `Note`. |
| 2015 | "name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}" |
| 2016 | "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. |
| 2017 | "distribution": [ # The various channels by which a package is distributed. |
| 2018 | { # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror |
| 2019 | "architecture": "A String", # The CPU architecture for which packages in this distribution channel were built |
| 2020 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 2021 | "description": "A String", # The distribution channel-specific description of this package. |
| 2022 | "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] | 2023 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 2024 | "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] | 2025 | "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] | 2026 | "name": "A String", # The main part of the version name. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2027 | "revision": "A String", # The iteration of the package build from the above version. |
| 2028 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2029 | "maintainer": "A String", # A freeform string denoting the maintainer of this package. |
| 2030 | "url": "A String", # The distribution channel-specific homepage for this package. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 2031 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2032 | ], |
| 2033 | "name": "A String", # The name of the package. |
| 2034 | }, |
| 2035 | "relatedUrl": [ # URLs associated with this note |
| 2036 | { # Metadata for any related URL information |
| 2037 | "label": "A String", # Label to describe usage of the URL |
| 2038 | "url": "A String", # Specific URL to associate with the note |
| 2039 | }, |
| 2040 | ], |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2041 | "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. |
| 2042 | "dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata") |
| 2043 | "spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file |
| 2044 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2045 | "shortDescription": "A String", # A one sentence description of this `Note`. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2046 | "spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File. |
| 2047 | "checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package |
| 2048 | "A String", |
| 2049 | ], |
| 2050 | "fileType": "A String", # This field provides information about the type of file identified |
| 2051 | "title": "A String", # Identify the full path and filename that corresponds to the file information in this section |
| 2052 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2053 | "spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2054 | "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 |
| 2055 | "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 |
| 2056 | "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 |
| 2057 | "copyright": "A String", # Identify the copyright holders of the package, as well as any dates present |
| 2058 | "detailedDescription": "A String", # A more detailed description of the package |
| 2059 | "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 |
| 2060 | "externalRefs": [ # ExternalRef |
| 2061 | { # 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 |
| 2062 | "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 |
| 2063 | "comment": "A String", # Human-readable information about the purpose and target of the reference |
| 2064 | "locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location |
| 2065 | "type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category) |
| 2066 | }, |
| 2067 | ], |
| 2068 | "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 |
| 2069 | "A String", |
| 2070 | ], |
| 2071 | "homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2072 | "licenseDeclared": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # List the licenses that have been declared by the authors of the package |
| 2073 | "comments": "A String", # Comments |
| 2074 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 2075 | }, |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2076 | "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 |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2077 | "packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2078 | "summaryDescription": "A String", # A short description of the package |
| 2079 | "supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file |
| 2080 | "title": "A String", # Identify the full name of the package as given by the Package Originator |
| 2081 | "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 |
| 2082 | "version": "A String", # Identify the version of the package |
| 2083 | }, |
| 2084 | "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. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2085 | "type": "A String", # The type of relationship between the source and target SPDX elements |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2086 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2087 | "updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests. |
| 2088 | "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. |
| 2089 | "distributions": [ # Metadata about the upgrade for each specific operating system. |
| 2090 | { # 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. |
| 2091 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 2092 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 2093 | "cve": [ # The cve that would be resolved by this upgrade. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2094 | "A String", |
| 2095 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2096 | "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] | 2097 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2098 | ], |
| 2099 | "package": "A String", # Required - The package this Upgrade is for. |
| 2100 | "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. |
| 2101 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 2102 | "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] | 2103 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 2104 | "name": "A String", # The main part of the version name. |
| 2105 | "revision": "A String", # The iteration of the package build from the above version. |
| 2106 | }, |
| 2107 | }, |
| 2108 | "vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note. |
| 2109 | "cvssScore": 3.14, # The CVSS score for this Vulnerability. |
| 2110 | "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. |
| 2111 | { # 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 |
| 2112 | "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. |
| 2113 | "description": "A String", # A vendor-specific description of this note. |
| 2114 | "fixedLocation": { # The location of the vulnerability # The fix for this specific package version. |
| 2115 | "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. |
| 2116 | "package": "A String", # The package being described. |
| 2117 | "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. |
| 2118 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 2119 | "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] | 2120 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 2121 | "name": "A String", # The main part of the version name. |
| 2122 | "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] | 2123 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2124 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2125 | "isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details. |
| 2126 | "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. |
| 2127 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 2128 | "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] | 2129 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 2130 | "name": "A String", # The main part of the version name. |
| 2131 | "revision": "A String", # The iteration of the package build from the above version. |
| 2132 | }, |
| 2133 | "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. |
| 2134 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 2135 | "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] | 2136 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 2137 | "name": "A String", # The main part of the version name. |
| 2138 | "revision": "A String", # The iteration of the package build from the above version. |
| 2139 | }, |
| 2140 | "package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests. |
| 2141 | "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc) |
| 2142 | "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] | 2143 | "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] | 2144 | "vendor": "A String", # The vendor of the product. e.g. "google" |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2145 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2146 | ], |
| 2147 | "severity": "A String", # Note provider assigned impact of the vulnerability |
| 2148 | }, |
| 2149 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2150 | </div> |
| 2151 | |
| 2152 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2153 | <code class="details" id="getVulnerabilitySummary">getVulnerabilitySummary(parent, filter=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2154 | <pre>Gets a summary of the number and severity of occurrences. |
| 2155 | |
| 2156 | Args: |
| 2157 | parent: string, This contains the project Id for example: projects/{project_id} (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2158 | filter: string, The filter expression. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2159 | x__xgafv: string, V1 error format. |
| 2160 | Allowed values |
| 2161 | 1 - v1 error format |
| 2162 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2163 | |
| 2164 | Returns: |
| 2165 | An object of the form: |
| 2166 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 2167 | { # A summary of how many vulnz occurrences there are per severity type. counts by groups, or if we should have different summary messages like this. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2168 | "counts": [ # A map of how many occurrences were found for each severity. |
| 2169 | { # The number of occurrences created for a specific severity. |
| 2170 | "count": "A String", # The number of occurrences with the severity. |
| 2171 | "severity": "A String", # The severity of the occurrences. |
| 2172 | }, |
| 2173 | ], |
| 2174 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2175 | </div> |
| 2176 | |
| 2177 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2178 | <code class="details" id="list">list(parent, filter=None, kind=None, name=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2179 | <pre>Lists active `Occurrences` for a given project matching the filters. |
| 2180 | |
| 2181 | Args: |
| 2182 | parent: string, This contains the project Id for example: projects/{project_id}. (required) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 2183 | filter: string, The filter expression. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 2184 | kind: string, The kind of occurrences to filter on. |
| 2185 | Allowed values |
| 2186 | KIND_UNSPECIFIED - Unknown |
| 2187 | PACKAGE_VULNERABILITY - The note and occurrence represent a package vulnerability. |
| 2188 | BUILD_DETAILS - The note and occurrence assert build provenance. |
| 2189 | IMAGE_BASIS - This represents an image basis relationship. |
| 2190 | PACKAGE_MANAGER - This represents a package installed via a package manager. |
| 2191 | DEPLOYABLE - The note and occurrence track deployment events. |
| 2192 | DISCOVERY - The note and occurrence track the initial discovery status of a resource. |
| 2193 | ATTESTATION_AUTHORITY - This represents a logical "role" that can attest to artifacts. |
| 2194 | UPGRADE - This represents an available software upgrade. |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 2195 | COMPLIANCE - This represents a compliance check that can be applied to a resource. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2196 | SBOM - This represents a software bill of materials. |
| 2197 | SPDX_PACKAGE - This represents an SPDX Package. |
| 2198 | SPDX_FILE - This represents an SPDX File. |
| 2199 | SPDX_RELATIONSHIP - This represents an SPDX Relationship. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2200 | DSSE_ATTESTATION - This represents a DSSE attestation Note |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2201 | name: string, The name field contains the project Id. For example: "projects/{project_id} @Deprecated |
| 2202 | pageSize: integer, Number of occurrences to return in the list. |
| 2203 | 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] | 2204 | x__xgafv: string, V1 error format. |
| 2205 | Allowed values |
| 2206 | 1 - v1 error format |
| 2207 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2208 | |
| 2209 | Returns: |
| 2210 | An object of the form: |
| 2211 | |
| 2212 | { # Response including listed active occurrences. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2213 | "nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results. |
| 2214 | "occurrences": [ # The occurrences requested. |
| 2215 | { # `Occurrence` includes information about analysis occurrences for an image. |
| 2216 | "attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact. |
| 2217 | "pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. |
| 2218 | "contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). |
| 2219 | "pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. |
| 2220 | "signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. |
| 2221 | }, |
| 2222 | }, |
| 2223 | "buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build. |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 2224 | "intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2225 | "builderConfig": { # required |
| 2226 | "id": "A String", |
| 2227 | }, |
| 2228 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 2229 | "A String", |
| 2230 | ], |
| 2231 | "metadata": { # Other properties of the build. |
| 2232 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 2233 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 2234 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 2235 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 2236 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 2237 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 2238 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 2239 | }, |
| 2240 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 2241 | }, |
| 2242 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 2243 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 2244 | { |
| 2245 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2246 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2247 | ], |
| 2248 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 2249 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 2250 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 2251 | { |
| 2252 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2253 | }, |
| 2254 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2255 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 2256 | }, |
| 2257 | }, |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 2258 | "intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope. |
| 2259 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 2260 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 2261 | "provenance": { # provenance is a predicate of type intotoprovenance |
| 2262 | "builderConfig": { # required |
| 2263 | "id": "A String", |
| 2264 | }, |
| 2265 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 2266 | "A String", |
| 2267 | ], |
| 2268 | "metadata": { # Other properties of the build. |
| 2269 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 2270 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 2271 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 2272 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 2273 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 2274 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 2275 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 2276 | }, |
| 2277 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 2278 | }, |
| 2279 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 2280 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| 2281 | { |
| 2282 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2283 | }, |
| 2284 | ], |
| 2285 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 2286 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 2287 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 2288 | { |
| 2289 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2290 | }, |
| 2291 | ], |
| 2292 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 2293 | }, |
| 2294 | }, |
| 2295 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 2296 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 2297 | "id": "A String", # id is the id of the slsa provenance builder |
| 2298 | }, |
| 2299 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 2300 | { # Material is a material used in the generation of the provenance |
| 2301 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 2302 | "a_key": "A String", |
| 2303 | }, |
| 2304 | "uri": "A String", # uri is the uri of the material |
| 2305 | }, |
| 2306 | ], |
| 2307 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 2308 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 2309 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 2310 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 2311 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 2312 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 2313 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 2314 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 2315 | }, |
| 2316 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 2317 | }, |
| 2318 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 2319 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 2320 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2321 | }, |
| 2322 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 2323 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 2324 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 2325 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2326 | }, |
| 2327 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 2328 | }, |
| 2329 | }, |
| 2330 | "subject": [ # subject is the subjects of the intoto statement |
| 2331 | { # Subject refers to the subject of the intoto statement |
| 2332 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| 2333 | "a_key": "A String", |
| 2334 | }, |
| 2335 | "name": "A String", # name is the name of the Subject used here |
| 2336 | }, |
| 2337 | ], |
| 2338 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2339 | "provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance |
| 2340 | "buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. |
| 2341 | "a_key": "A String", |
| 2342 | }, |
| 2343 | "builderVersion": "A String", # Version string of the builder at the time this build was executed. |
| 2344 | "builtArtifacts": [ # Output of the build. |
| 2345 | { # Artifact describes a build product. |
| 2346 | "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. |
| 2347 | "id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456 |
| 2348 | "name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto. |
| 2349 | "names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. |
| 2350 | "A String", |
| 2351 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 2352 | }, |
| 2353 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2354 | "commands": [ # Commands requested by the build. |
| 2355 | { # Command describes a step performed as part of the build pipeline. |
| 2356 | "args": [ # Command-line arguments used when executing this Command. |
| 2357 | "A String", |
| 2358 | ], |
| 2359 | "dir": "A String", # Working directory (relative to project source root) used when running this Command. |
| 2360 | "env": [ # Environment variables set before running this Command. |
| 2361 | "A String", |
| 2362 | ], |
| 2363 | "id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency. |
| 2364 | "name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. |
| 2365 | "waitFor": [ # The ID(s) of the Command(s) that this Command depends on. |
| 2366 | "A String", |
| 2367 | ], |
| 2368 | }, |
| 2369 | ], |
| 2370 | "createTime": "A String", # Time at which the build was created. |
| 2371 | "creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. |
| 2372 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 2373 | "id": "A String", # Unique identifier of the build. |
| 2374 | "logsBucket": "A String", # Google Cloud Storage bucket where logs were written. |
| 2375 | "projectId": "A String", # ID of the project. |
| 2376 | "sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build. |
| 2377 | "additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. |
| 2378 | { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2379 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2380 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 2381 | "kind": "A String", # The alias kind. |
| 2382 | "name": "A String", # The alias name. |
| 2383 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2384 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2385 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 2386 | "projectId": "A String", # The ID of the project. |
| 2387 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 2388 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2389 | "uid": "A String", # A server-assigned, globally unique identifier. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2390 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2391 | "revisionId": "A String", # A revision ID. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2392 | }, |
| 2393 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2394 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 2395 | "kind": "A String", # The alias kind. |
| 2396 | "name": "A String", # The alias name. |
| 2397 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2398 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2399 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 2400 | "revisionId": "A String", # A revision (commit) ID. |
| 2401 | }, |
| 2402 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 2403 | "revisionId": "A String", # Required. Git commit hash. |
| 2404 | "url": "A String", # Git repository URL. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2405 | }, |
| 2406 | "labels": { # Labels with user defined metadata. |
| 2407 | "a_key": "A String", |
| 2408 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2409 | }, |
| 2410 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2411 | "artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location. |
| 2412 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 2413 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 2414 | "object": "A String", # Google Cloud Storage object containing source. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2415 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2416 | "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location. |
| 2417 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| 2418 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 2419 | "kind": "A String", # The alias kind. |
| 2420 | "name": "A String", # The alias name. |
| 2421 | }, |
| 2422 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| 2423 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 2424 | "projectId": "A String", # The ID of the project. |
| 2425 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 2426 | }, |
| 2427 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 2428 | }, |
| 2429 | "revisionId": "A String", # A revision ID. |
| 2430 | }, |
| 2431 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 2432 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 2433 | "kind": "A String", # The alias kind. |
| 2434 | "name": "A String", # The alias name. |
| 2435 | }, |
| 2436 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| 2437 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 2438 | "revisionId": "A String", # A revision (commit) ID. |
| 2439 | }, |
| 2440 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 2441 | "revisionId": "A String", # Required. Git commit hash. |
| 2442 | "url": "A String", # Git repository URL. |
| 2443 | }, |
| 2444 | "labels": { # Labels with user defined metadata. |
| 2445 | "a_key": "A String", |
| 2446 | }, |
| 2447 | }, |
| 2448 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. |
| 2449 | "a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build. |
| 2450 | "fileHash": [ # Collection of file hashes. |
| 2451 | { # Container message for hash values. |
| 2452 | "type": "A String", # The type of hash that was performed. |
| 2453 | "value": "A String", # The hash value. |
| 2454 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2455 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2456 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2457 | }, |
| 2458 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo. |
| 2459 | "branchName": "A String", # Name of the branch to build. |
| 2460 | "commitSha": "A String", # Explicit commit SHA to build. |
| 2461 | "projectId": "A String", # ID of the project that owns the repo. |
| 2462 | "repoName": "A String", # Name of the repo. |
| 2463 | "tagName": "A String", # Name of the tag to build. |
| 2464 | }, |
| 2465 | "storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage. |
| 2466 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 2467 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 2468 | "object": "A String", # Google Cloud Storage object containing source. |
| 2469 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2470 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2471 | "startTime": "A String", # Time at which execution of the build was started. |
| 2472 | "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2473 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2474 | "provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. |
| 2475 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 2476 | "compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes whether or not a resource passes compliance checks. |
| 2477 | "nonComplianceReason": "A String", # The reason for non compliance of these files. |
| 2478 | "nonCompliantFiles": [ # A list of files which are violating compliance checks. |
| 2479 | { # Details about files that caused a compliance check to fail. |
| 2480 | "displayCommand": "A String", # Command to display the non-compliant files. |
| 2481 | "path": "A String", # display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'. Empty if `display_command` is set. |
| 2482 | "reason": "A String", # Explains why a file is non compliant for a CIS check. |
| 2483 | }, |
| 2484 | ], |
| 2485 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2486 | "createTime": "A String", # Output only. The time this `Occurrence` was created. |
| 2487 | "deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime. |
| 2488 | "address": "A String", # Address of the runtime element hosting this deployment. |
| 2489 | "config": "A String", # Configuration used to create this deployment. |
| 2490 | "deployTime": "A String", # Beginning of the lifetime of this deployment. |
| 2491 | "platform": "A String", # Platform hosting this deployment. |
| 2492 | "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. |
| 2493 | "A String", |
| 2494 | ], |
| 2495 | "undeployTime": "A String", # End of the lifetime of this deployment. |
| 2496 | "userEmail": "A String", # Identity of the user that triggered this deployment. |
| 2497 | }, |
| 2498 | "derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note. |
| 2499 | "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence. |
| 2500 | "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis. |
| 2501 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image. |
| 2502 | "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. |
| 2503 | "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] | 2504 | "A String", |
| 2505 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2506 | "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] | 2507 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2508 | "layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. |
| 2509 | { # Layer holds metadata specific to a layer of a Docker image. |
| 2510 | "arguments": "A String", # The recovered arguments to the Dockerfile directive. |
| 2511 | "directive": "A String", # The recovered Dockerfile directive used to construct this layer. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2512 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2513 | ], |
| 2514 | }, |
| 2515 | "discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource. |
| 2516 | "analysisStatus": "A String", # The status of discovery for the resource. |
| 2517 | "analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API. |
| 2518 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 2519 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 2520 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2521 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2522 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2523 | ], |
| 2524 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 2525 | }, |
| 2526 | "continuousAnalysis": "A String", # Whether the resource is continuously analyzed. |
| 2527 | "cpe": "A String", # The CPE of the resource being scanned. |
| 2528 | "operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. |
| 2529 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 2530 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 2531 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 2532 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 2533 | { |
| 2534 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2535 | }, |
| 2536 | ], |
| 2537 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 2538 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2539 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 2540 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2541 | }, |
| 2542 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 2543 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 2544 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2545 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2546 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2547 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2548 | "dsseAttestation": { # An occurrence describing an attestation on a resource # This represents a DSSE attestation occurrence |
| 2549 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. |
| 2550 | "payload": "A String", # The bytes being signed |
| 2551 | "payloadType": "A String", # The type of payload being signed |
| 2552 | "signatures": [ # The signatures over the payload |
| 2553 | { # A DSSE signature |
| 2554 | "keyid": "A String", # A reference id to the key being used for signing |
| 2555 | "sig": "A String", # The signature itself |
| 2556 | }, |
| 2557 | ], |
| 2558 | }, |
| 2559 | "statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 2560 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 2561 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 2562 | "provenance": { # provenance is a predicate of type intotoprovenance |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2563 | "builderConfig": { # required |
| 2564 | "id": "A String", |
| 2565 | }, |
| 2566 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 2567 | "A String", |
| 2568 | ], |
| 2569 | "metadata": { # Other properties of the build. |
| 2570 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 2571 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 2572 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 2573 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 2574 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 2575 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 2576 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 2577 | }, |
| 2578 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 2579 | }, |
| 2580 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 2581 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 2582 | { |
| 2583 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2584 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2585 | ], |
| 2586 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 2587 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 2588 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 2589 | { |
| 2590 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2591 | }, |
| 2592 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2593 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 2594 | }, |
| 2595 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 2596 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 2597 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 2598 | "id": "A String", # id is the id of the slsa provenance builder |
| 2599 | }, |
| 2600 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 2601 | { # Material is a material used in the generation of the provenance |
| 2602 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 2603 | "a_key": "A String", |
| 2604 | }, |
| 2605 | "uri": "A String", # uri is the uri of the material |
| 2606 | }, |
| 2607 | ], |
| 2608 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 2609 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 2610 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 2611 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 2612 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 2613 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 2614 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 2615 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 2616 | }, |
| 2617 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 2618 | }, |
| 2619 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 2620 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 2621 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2622 | }, |
| 2623 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 2624 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 2625 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 2626 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2627 | }, |
| 2628 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 2629 | }, |
| 2630 | }, |
| 2631 | "subject": [ # subject is the subjects of the intoto statement |
| 2632 | { # Subject refers to the subject of the intoto statement |
| 2633 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2634 | "a_key": "A String", |
| 2635 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 2636 | "name": "A String", # name is the name of the Subject used here |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2637 | }, |
| 2638 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2639 | }, |
| 2640 | }, |
| 2641 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse |
| 2642 | "payload": "A String", # The bytes being signed |
| 2643 | "payloadType": "A String", # The type of payload being signed |
| 2644 | "signatures": [ # The signatures over the payload |
| 2645 | { # A DSSE signature |
| 2646 | "keyid": "A String", # A reference id to the key being used for signing |
| 2647 | "sig": "A String", # The signature itself |
| 2648 | }, |
| 2649 | ], |
| 2650 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2651 | "installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource. |
| 2652 | "location": [ # All of the places within the filesystem versions of this package have been found. |
| 2653 | { # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status |
| 2654 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 2655 | "path": "A String", # The path from which we gathered that this package/version is installed. |
| 2656 | "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 installed at this location. |
| 2657 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 2658 | "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] | 2659 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 2660 | "name": "A String", # The main part of the version name. |
| 2661 | "revision": "A String", # The iteration of the package build from the above version. |
| 2662 | }, |
| 2663 | }, |
| 2664 | ], |
| 2665 | "name": "A String", # Output only. The name of the installed package. |
| 2666 | }, |
| 2667 | "kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests. |
| 2668 | "name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" |
| 2669 | "noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests. |
| 2670 | "remediation": "A String", # A description of actions that can be taken to remedy the `Note` |
| 2671 | "resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies. |
| 2672 | "contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest. |
| 2673 | "type": "A String", # The type of hash that was performed. |
| 2674 | "value": "A String", # The hash value. |
| 2675 | }, |
| 2676 | "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian". |
| 2677 | "uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image. |
| 2678 | }, |
| 2679 | "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2680 | "sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific software bill of materials document. |
| 2681 | "createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard |
| 2682 | "creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields |
| 2683 | "creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name |
| 2684 | "A String", |
| 2685 | ], |
| 2686 | "documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document |
| 2687 | "externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document |
| 2688 | "A String", |
| 2689 | ], |
| 2690 | "id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally |
| 2691 | "licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created |
| 2692 | "namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter |
| 2693 | "title": "A String", # Identify name of this document as designated by creator |
| 2694 | }, |
| 2695 | "spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File. |
| 2696 | "attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts |
| 2697 | "A String", |
| 2698 | ], |
| 2699 | "comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file |
| 2700 | "contributors": [ # This field provides a place for the SPDX file creator to record file contributors |
| 2701 | "A String", |
| 2702 | ], |
| 2703 | "copyright": "A String", # Identify the copyright holder of the file, as well as any dates present |
| 2704 | "filesLicenseInfo": [ # This field contains the license information actually found in the file, if any |
| 2705 | "A String", |
| 2706 | ], |
| 2707 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2708 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined |
| 2709 | "comments": "A String", # Comments |
| 2710 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 2711 | }, |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2712 | "notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file |
| 2713 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2714 | "spdxPackage": { # PackageInfoOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2715 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described |
| 2716 | "filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2717 | "homePage": "A String", # Output only. Provide a place for the SPDX file creator to record a web site that serves as the package's home page |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2718 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2719 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # package or alternative values, if the governing license cannot be determined |
| 2720 | "comments": "A String", # Comments |
| 2721 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 2722 | }, |
| 2723 | "packageType": "A String", # Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2724 | "sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2725 | "summaryDescription": "A String", # Output only. A short description of the package |
| 2726 | "title": "A String", # Output only. Identify the full name of the package as given by the Package Originator |
| 2727 | "version": "A String", # Output only. Identify the version of the package |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2728 | }, |
| 2729 | "spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific relationship between SPDX elements. |
| 2730 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship |
| 2731 | "source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc) |
| 2732 | "target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 2733 | "type": "A String", # Output only. The type of relationship between the source and target SPDX elements |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 2734 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2735 | "updateTime": "A String", # Output only. The time this `Occurrence` was last updated. |
| 2736 | "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade. |
| 2737 | "distribution": { # 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. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence. |
| 2738 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 2739 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 2740 | "cve": [ # The cve that would be resolved by this upgrade. |
| 2741 | "A String", |
| 2742 | ], |
| 2743 | "severity": "A String", # The severity as specified by the upstream operating system. |
| 2744 | }, |
| 2745 | "package": "A String", # Required - The package this Upgrade is for. |
| 2746 | "parsedVersion": { # 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 a machine + human readable form. |
| 2747 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 2748 | "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] | 2749 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 2750 | "name": "A String", # The main part of the version name. |
| 2751 | "revision": "A String", # The iteration of the package build from the above version. |
| 2752 | }, |
| 2753 | }, |
| 2754 | "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note. |
| 2755 | "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 2756 | "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple package issues for this vulnerability, they can have different effective severities because some might come from the distro and some might come from installed language packs (e.g. Maven JARs or Go binaries). For this reason, it is advised to use the effective severity on the PackageIssue level, as this field may eventually be deprecated. In the case where multiple PackageIssues have different effective severities, the one set here will be the highest severity of any of the PackageIssues. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2757 | "packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource. |
| 2758 | { # This message wraps a location affected by a vulnerability and its associated fix (if one is available). |
| 2759 | "affectedLocation": { # The location of the vulnerability # The location of the vulnerability. |
| 2760 | "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. |
| 2761 | "package": "A String", # The package being described. |
| 2762 | "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. |
| 2763 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 2764 | "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] | 2765 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 2766 | "name": "A String", # The main part of the version name. |
| 2767 | "revision": "A String", # The iteration of the package build from the above version. |
| 2768 | }, |
| 2769 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 2770 | "effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when distro or language system has not yet assigned a severity for this vulnerability. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2771 | "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability. |
| 2772 | "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. |
| 2773 | "package": "A String", # The package being described. |
| 2774 | "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. |
| 2775 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 2776 | "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] | 2777 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 2778 | "name": "A String", # The main part of the version name. |
| 2779 | "revision": "A String", # The iteration of the package build from the above version. |
| 2780 | }, |
| 2781 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 2782 | "packageType": "A String", # The type of package (e.g. OS, MAVEN, GO). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2783 | "severityName": "A String", |
| 2784 | }, |
| 2785 | ], |
| 2786 | "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 2787 | "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). This may be deprecated in the future because we can have multiple PackageIssues with different package types. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2788 | }, |
| 2789 | }, |
| 2790 | ], |
| 2791 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2792 | </div> |
| 2793 | |
| 2794 | <div class="method"> |
| 2795 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 2796 | <pre>Retrieves the next page of results. |
| 2797 | |
| 2798 | Args: |
| 2799 | previous_request: The request for the previous page. (required) |
| 2800 | previous_response: The response from the request for the previous page. (required) |
| 2801 | |
| 2802 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2803 | 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] | 2804 | page. Returns None if there are no more items in the collection. |
| 2805 | </pre> |
| 2806 | </div> |
| 2807 | |
| 2808 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2809 | <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] | 2810 | <pre>Updates an existing occurrence. |
| 2811 | |
| 2812 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 2813 | name: string, The name of the occurrence. Should be of the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}". (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2814 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 2815 | The object takes the form of: |
| 2816 | |
| 2817 | { # `Occurrence` includes information about analysis occurrences for an image. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2818 | "attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact. |
| 2819 | "pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. |
| 2820 | "contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). |
| 2821 | "pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. |
| 2822 | "signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. |
| 2823 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2824 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2825 | "buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build. |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 2826 | "intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2827 | "builderConfig": { # required |
| 2828 | "id": "A String", |
| 2829 | }, |
| 2830 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 2831 | "A String", |
| 2832 | ], |
| 2833 | "metadata": { # Other properties of the build. |
| 2834 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 2835 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 2836 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 2837 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 2838 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 2839 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 2840 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 2841 | }, |
| 2842 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 2843 | }, |
| 2844 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 2845 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 2846 | { |
| 2847 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2848 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2849 | ], |
| 2850 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 2851 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 2852 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 2853 | { |
| 2854 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2855 | }, |
| 2856 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 2857 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 2858 | }, |
| 2859 | }, |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 2860 | "intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope. |
| 2861 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 2862 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 2863 | "provenance": { # provenance is a predicate of type intotoprovenance |
| 2864 | "builderConfig": { # required |
| 2865 | "id": "A String", |
| 2866 | }, |
| 2867 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 2868 | "A String", |
| 2869 | ], |
| 2870 | "metadata": { # Other properties of the build. |
| 2871 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 2872 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 2873 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 2874 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 2875 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 2876 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 2877 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 2878 | }, |
| 2879 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 2880 | }, |
| 2881 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 2882 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| 2883 | { |
| 2884 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2885 | }, |
| 2886 | ], |
| 2887 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 2888 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 2889 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 2890 | { |
| 2891 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2892 | }, |
| 2893 | ], |
| 2894 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 2895 | }, |
| 2896 | }, |
| 2897 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 2898 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 2899 | "id": "A String", # id is the id of the slsa provenance builder |
| 2900 | }, |
| 2901 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 2902 | { # Material is a material used in the generation of the provenance |
| 2903 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 2904 | "a_key": "A String", |
| 2905 | }, |
| 2906 | "uri": "A String", # uri is the uri of the material |
| 2907 | }, |
| 2908 | ], |
| 2909 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 2910 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 2911 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 2912 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 2913 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 2914 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 2915 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 2916 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 2917 | }, |
| 2918 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 2919 | }, |
| 2920 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 2921 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 2922 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2923 | }, |
| 2924 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 2925 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 2926 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 2927 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2928 | }, |
| 2929 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 2930 | }, |
| 2931 | }, |
| 2932 | "subject": [ # subject is the subjects of the intoto statement |
| 2933 | { # Subject refers to the subject of the intoto statement |
| 2934 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| 2935 | "a_key": "A String", |
| 2936 | }, |
| 2937 | "name": "A String", # name is the name of the Subject used here |
| 2938 | }, |
| 2939 | ], |
| 2940 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2941 | "provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2942 | "buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. |
| 2943 | "a_key": "A String", |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2944 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2945 | "builderVersion": "A String", # Version string of the builder at the time this build was executed. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2946 | "builtArtifacts": [ # Output of the build. |
| 2947 | { # Artifact describes a build product. |
| 2948 | "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2949 | "id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456 |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2950 | "name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 2951 | "names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. |
| 2952 | "A String", |
| 2953 | ], |
| 2954 | }, |
| 2955 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2956 | "commands": [ # Commands requested by the build. |
| 2957 | { # Command describes a step performed as part of the build pipeline. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2958 | "args": [ # Command-line arguments used when executing this Command. |
| 2959 | "A String", |
| 2960 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2961 | "dir": "A String", # Working directory (relative to project source root) used when running this Command. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2962 | "env": [ # Environment variables set before running this Command. |
| 2963 | "A String", |
| 2964 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2965 | "id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency. |
| 2966 | "name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. |
| 2967 | "waitFor": [ # The ID(s) of the Command(s) that this Command depends on. |
| 2968 | "A String", |
| 2969 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2970 | }, |
| 2971 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 2972 | "createTime": "A String", # Time at which the build was created. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 2973 | "creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. |
| 2974 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 2975 | "id": "A String", # Unique identifier of the build. |
| 2976 | "logsBucket": "A String", # Google Cloud Storage bucket where logs were written. |
| 2977 | "projectId": "A String", # ID of the project. |
| 2978 | "sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build. |
| 2979 | "additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. |
| 2980 | { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. |
| 2981 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| 2982 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 2983 | "kind": "A String", # The alias kind. |
| 2984 | "name": "A String", # The alias name. |
| 2985 | }, |
| 2986 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| 2987 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 2988 | "projectId": "A String", # The ID of the project. |
| 2989 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 2990 | }, |
| 2991 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 2992 | }, |
| 2993 | "revisionId": "A String", # A revision ID. |
| 2994 | }, |
| 2995 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 2996 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 2997 | "kind": "A String", # The alias kind. |
| 2998 | "name": "A String", # The alias name. |
| 2999 | }, |
| 3000 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| 3001 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 3002 | "revisionId": "A String", # A revision (commit) ID. |
| 3003 | }, |
| 3004 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 3005 | "revisionId": "A String", # Required. Git commit hash. |
| 3006 | "url": "A String", # Git repository URL. |
| 3007 | }, |
| 3008 | "labels": { # Labels with user defined metadata. |
| 3009 | "a_key": "A String", |
| 3010 | }, |
| 3011 | }, |
| 3012 | ], |
| 3013 | "artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location. |
| 3014 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 3015 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 3016 | "object": "A String", # Google Cloud Storage object containing source. |
| 3017 | }, |
| 3018 | "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location. |
| 3019 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| 3020 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 3021 | "kind": "A String", # The alias kind. |
| 3022 | "name": "A String", # The alias name. |
| 3023 | }, |
| 3024 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| 3025 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 3026 | "projectId": "A String", # The ID of the project. |
| 3027 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 3028 | }, |
| 3029 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 3030 | }, |
| 3031 | "revisionId": "A String", # A revision ID. |
| 3032 | }, |
| 3033 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 3034 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 3035 | "kind": "A String", # The alias kind. |
| 3036 | "name": "A String", # The alias name. |
| 3037 | }, |
| 3038 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| 3039 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 3040 | "revisionId": "A String", # A revision (commit) ID. |
| 3041 | }, |
| 3042 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 3043 | "revisionId": "A String", # Required. Git commit hash. |
| 3044 | "url": "A String", # Git repository URL. |
| 3045 | }, |
| 3046 | "labels": { # Labels with user defined metadata. |
| 3047 | "a_key": "A String", |
| 3048 | }, |
| 3049 | }, |
| 3050 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. |
| 3051 | "a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build. |
| 3052 | "fileHash": [ # Collection of file hashes. |
| 3053 | { # Container message for hash values. |
| 3054 | "type": "A String", # The type of hash that was performed. |
| 3055 | "value": "A String", # The hash value. |
| 3056 | }, |
| 3057 | ], |
| 3058 | }, |
| 3059 | }, |
| 3060 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo. |
| 3061 | "branchName": "A String", # Name of the branch to build. |
| 3062 | "commitSha": "A String", # Explicit commit SHA to build. |
| 3063 | "projectId": "A String", # ID of the project that owns the repo. |
| 3064 | "repoName": "A String", # Name of the repo. |
| 3065 | "tagName": "A String", # Name of the tag to build. |
| 3066 | }, |
| 3067 | "storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage. |
| 3068 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 3069 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 3070 | "object": "A String", # Google Cloud Storage object containing source. |
| 3071 | }, |
| 3072 | }, |
| 3073 | "startTime": "A String", # Time at which execution of the build was started. |
| 3074 | "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3075 | }, |
| 3076 | "provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. |
| 3077 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 3078 | "compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes whether or not a resource passes compliance checks. |
| 3079 | "nonComplianceReason": "A String", # The reason for non compliance of these files. |
| 3080 | "nonCompliantFiles": [ # A list of files which are violating compliance checks. |
| 3081 | { # Details about files that caused a compliance check to fail. |
| 3082 | "displayCommand": "A String", # Command to display the non-compliant files. |
| 3083 | "path": "A String", # display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'. Empty if `display_command` is set. |
| 3084 | "reason": "A String", # Explains why a file is non compliant for a CIS check. |
| 3085 | }, |
| 3086 | ], |
| 3087 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3088 | "createTime": "A String", # Output only. The time this `Occurrence` was created. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3089 | "deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3090 | "address": "A String", # Address of the runtime element hosting this deployment. |
| 3091 | "config": "A String", # Configuration used to create this deployment. |
| 3092 | "deployTime": "A String", # Beginning of the lifetime of this deployment. |
| 3093 | "platform": "A String", # Platform hosting this deployment. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3094 | "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. |
| 3095 | "A String", |
| 3096 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3097 | "undeployTime": "A String", # End of the lifetime of this deployment. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3098 | "userEmail": "A String", # Identity of the user that triggered this deployment. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3099 | }, |
| 3100 | "derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note. |
| 3101 | "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence. |
| 3102 | "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis. |
| 3103 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3104 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3105 | "v2Blob": [ # The ordered list of v2 blobs that represent a given image. |
| 3106 | "A String", |
| 3107 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3108 | "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] | 3109 | }, |
| 3110 | "layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. |
| 3111 | { # Layer holds metadata specific to a layer of a Docker image. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3112 | "arguments": "A String", # The recovered arguments to the Dockerfile directive. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3113 | "directive": "A String", # The recovered Dockerfile directive used to construct this layer. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3114 | }, |
| 3115 | ], |
| 3116 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3117 | "discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 3118 | "analysisStatus": "A String", # The status of discovery for the resource. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 3119 | "analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API. |
| 3120 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 3121 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 3122 | { |
| 3123 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3124 | }, |
| 3125 | ], |
| 3126 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 3127 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3128 | "continuousAnalysis": "A String", # Whether the resource is continuously analyzed. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3129 | "cpe": "A String", # The CPE of the resource being scanned. |
| 3130 | "operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. |
| 3131 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 3132 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| 3133 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 3134 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 3135 | { |
| 3136 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3137 | }, |
| 3138 | ], |
| 3139 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 3140 | }, |
| 3141 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 3142 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3143 | }, |
| 3144 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 3145 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 3146 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3147 | }, |
| 3148 | }, |
| 3149 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3150 | "dsseAttestation": { # An occurrence describing an attestation on a resource # This represents a DSSE attestation occurrence |
| 3151 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. |
| 3152 | "payload": "A String", # The bytes being signed |
| 3153 | "payloadType": "A String", # The type of payload being signed |
| 3154 | "signatures": [ # The signatures over the payload |
| 3155 | { # A DSSE signature |
| 3156 | "keyid": "A String", # A reference id to the key being used for signing |
| 3157 | "sig": "A String", # The signature itself |
| 3158 | }, |
| 3159 | ], |
| 3160 | }, |
| 3161 | "statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 3162 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 3163 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 3164 | "provenance": { # provenance is a predicate of type intotoprovenance |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3165 | "builderConfig": { # required |
| 3166 | "id": "A String", |
| 3167 | }, |
| 3168 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 3169 | "A String", |
| 3170 | ], |
| 3171 | "metadata": { # Other properties of the build. |
| 3172 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 3173 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 3174 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 3175 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 3176 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 3177 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 3178 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 3179 | }, |
| 3180 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 3181 | }, |
| 3182 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 3183 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 3184 | { |
| 3185 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3186 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3187 | ], |
| 3188 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 3189 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 3190 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 3191 | { |
| 3192 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3193 | }, |
| 3194 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3195 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 3196 | }, |
| 3197 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 3198 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 3199 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 3200 | "id": "A String", # id is the id of the slsa provenance builder |
| 3201 | }, |
| 3202 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 3203 | { # Material is a material used in the generation of the provenance |
| 3204 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 3205 | "a_key": "A String", |
| 3206 | }, |
| 3207 | "uri": "A String", # uri is the uri of the material |
| 3208 | }, |
| 3209 | ], |
| 3210 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 3211 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 3212 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 3213 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 3214 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 3215 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 3216 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 3217 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 3218 | }, |
| 3219 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 3220 | }, |
| 3221 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 3222 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 3223 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3224 | }, |
| 3225 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 3226 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 3227 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 3228 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3229 | }, |
| 3230 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 3231 | }, |
| 3232 | }, |
| 3233 | "subject": [ # subject is the subjects of the intoto statement |
| 3234 | { # Subject refers to the subject of the intoto statement |
| 3235 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3236 | "a_key": "A String", |
| 3237 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 3238 | "name": "A String", # name is the name of the Subject used here |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3239 | }, |
| 3240 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3241 | }, |
| 3242 | }, |
| 3243 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse |
| 3244 | "payload": "A String", # The bytes being signed |
| 3245 | "payloadType": "A String", # The type of payload being signed |
| 3246 | "signatures": [ # The signatures over the payload |
| 3247 | { # A DSSE signature |
| 3248 | "keyid": "A String", # A reference id to the key being used for signing |
| 3249 | "sig": "A String", # The signature itself |
| 3250 | }, |
| 3251 | ], |
| 3252 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3253 | "installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource. |
| 3254 | "location": [ # All of the places within the filesystem versions of this package have been found. |
| 3255 | { # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status |
| 3256 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 3257 | "path": "A String", # The path from which we gathered that this package/version is installed. |
| 3258 | "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 installed at this location. |
| 3259 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 3260 | "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] | 3261 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 3262 | "name": "A String", # The main part of the version name. |
| 3263 | "revision": "A String", # The iteration of the package build from the above version. |
| 3264 | }, |
| 3265 | }, |
| 3266 | ], |
| 3267 | "name": "A String", # Output only. The name of the installed package. |
| 3268 | }, |
| 3269 | "kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests. |
| 3270 | "name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" |
| 3271 | "noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests. |
| 3272 | "remediation": "A String", # A description of actions that can be taken to remedy the `Note` |
| 3273 | "resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies. |
| 3274 | "contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest. |
| 3275 | "type": "A String", # The type of hash that was performed. |
| 3276 | "value": "A String", # The hash value. |
| 3277 | }, |
| 3278 | "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian". |
| 3279 | "uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image. |
| 3280 | }, |
| 3281 | "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3282 | "sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific software bill of materials document. |
| 3283 | "createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard |
| 3284 | "creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields |
| 3285 | "creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name |
| 3286 | "A String", |
| 3287 | ], |
| 3288 | "documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document |
| 3289 | "externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document |
| 3290 | "A String", |
| 3291 | ], |
| 3292 | "id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally |
| 3293 | "licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created |
| 3294 | "namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter |
| 3295 | "title": "A String", # Identify name of this document as designated by creator |
| 3296 | }, |
| 3297 | "spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File. |
| 3298 | "attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts |
| 3299 | "A String", |
| 3300 | ], |
| 3301 | "comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file |
| 3302 | "contributors": [ # This field provides a place for the SPDX file creator to record file contributors |
| 3303 | "A String", |
| 3304 | ], |
| 3305 | "copyright": "A String", # Identify the copyright holder of the file, as well as any dates present |
| 3306 | "filesLicenseInfo": [ # This field contains the license information actually found in the file, if any |
| 3307 | "A String", |
| 3308 | ], |
| 3309 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3310 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined |
| 3311 | "comments": "A String", # Comments |
| 3312 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 3313 | }, |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3314 | "notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file |
| 3315 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3316 | "spdxPackage": { # PackageInfoOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3317 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described |
| 3318 | "filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3319 | "homePage": "A String", # Output only. Provide a place for the SPDX file creator to record a web site that serves as the package's home page |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3320 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3321 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # package or alternative values, if the governing license cannot be determined |
| 3322 | "comments": "A String", # Comments |
| 3323 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 3324 | }, |
| 3325 | "packageType": "A String", # Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3326 | "sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3327 | "summaryDescription": "A String", # Output only. A short description of the package |
| 3328 | "title": "A String", # Output only. Identify the full name of the package as given by the Package Originator |
| 3329 | "version": "A String", # Output only. Identify the version of the package |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3330 | }, |
| 3331 | "spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific relationship between SPDX elements. |
| 3332 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship |
| 3333 | "source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc) |
| 3334 | "target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3335 | "type": "A String", # Output only. The type of relationship between the source and target SPDX elements |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3336 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3337 | "updateTime": "A String", # Output only. The time this `Occurrence` was last updated. |
| 3338 | "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade. |
| 3339 | "distribution": { # 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. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence. |
| 3340 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 3341 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 3342 | "cve": [ # The cve that would be resolved by this upgrade. |
| 3343 | "A String", |
| 3344 | ], |
| 3345 | "severity": "A String", # The severity as specified by the upstream operating system. |
| 3346 | }, |
| 3347 | "package": "A String", # Required - The package this Upgrade is for. |
| 3348 | "parsedVersion": { # 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 a machine + human readable form. |
| 3349 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 3350 | "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] | 3351 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 3352 | "name": "A String", # The main part of the version name. |
| 3353 | "revision": "A String", # The iteration of the package build from the above version. |
| 3354 | }, |
| 3355 | }, |
| 3356 | "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note. |
| 3357 | "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 3358 | "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple package issues for this vulnerability, they can have different effective severities because some might come from the distro and some might come from installed language packs (e.g. Maven JARs or Go binaries). For this reason, it is advised to use the effective severity on the PackageIssue level, as this field may eventually be deprecated. In the case where multiple PackageIssues have different effective severities, the one set here will be the highest severity of any of the PackageIssues. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3359 | "packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource. |
| 3360 | { # This message wraps a location affected by a vulnerability and its associated fix (if one is available). |
| 3361 | "affectedLocation": { # The location of the vulnerability # The location of the vulnerability. |
| 3362 | "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. |
| 3363 | "package": "A String", # The package being described. |
| 3364 | "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. |
| 3365 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 3366 | "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] | 3367 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 3368 | "name": "A String", # The main part of the version name. |
| 3369 | "revision": "A String", # The iteration of the package build from the above version. |
| 3370 | }, |
| 3371 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 3372 | "effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when distro or language system has not yet assigned a severity for this vulnerability. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3373 | "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability. |
| 3374 | "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. |
| 3375 | "package": "A String", # The package being described. |
| 3376 | "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. |
| 3377 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 3378 | "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] | 3379 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 3380 | "name": "A String", # The main part of the version name. |
| 3381 | "revision": "A String", # The iteration of the package build from the above version. |
| 3382 | }, |
| 3383 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 3384 | "packageType": "A String", # The type of package (e.g. OS, MAVEN, GO). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3385 | "severityName": "A String", |
| 3386 | }, |
| 3387 | ], |
| 3388 | "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 3389 | "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). This may be deprecated in the future because we can have multiple PackageIssues with different package types. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3390 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3391 | } |
| 3392 | |
| 3393 | updateMask: string, The fields to update. |
| 3394 | x__xgafv: string, V1 error format. |
| 3395 | Allowed values |
| 3396 | 1 - v1 error format |
| 3397 | 2 - v2 error format |
| 3398 | |
| 3399 | Returns: |
| 3400 | An object of the form: |
| 3401 | |
| 3402 | { # `Occurrence` includes information about analysis occurrences for an image. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3403 | "attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact. |
| 3404 | "pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file. |
| 3405 | "contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema). |
| 3406 | "pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`. |
| 3407 | "signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload. |
| 3408 | }, |
| 3409 | }, |
| 3410 | "buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build. |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 3411 | "intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec. |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3412 | "builderConfig": { # required |
| 3413 | "id": "A String", |
| 3414 | }, |
| 3415 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 3416 | "A String", |
| 3417 | ], |
| 3418 | "metadata": { # Other properties of the build. |
| 3419 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 3420 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 3421 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 3422 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 3423 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 3424 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 3425 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 3426 | }, |
| 3427 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 3428 | }, |
| 3429 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 3430 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 3431 | { |
| 3432 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3433 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3434 | ], |
| 3435 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 3436 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 3437 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 3438 | { |
| 3439 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3440 | }, |
| 3441 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3442 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 3443 | }, |
| 3444 | }, |
| yoshi-code-bot | 466c9a9 | 2021-11-22 23:24:31 -0800 | [diff] [blame] | 3445 | "intotoStatement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". # In-toto Statement representation as defined in spec. The intoto_statement can contain any type of provenance. The serialized payload of the statement can be stored and signed in the Occurrence's envelope. |
| 3446 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 3447 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 3448 | "provenance": { # provenance is a predicate of type intotoprovenance |
| 3449 | "builderConfig": { # required |
| 3450 | "id": "A String", |
| 3451 | }, |
| 3452 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 3453 | "A String", |
| 3454 | ], |
| 3455 | "metadata": { # Other properties of the build. |
| 3456 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 3457 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 3458 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 3459 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 3460 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 3461 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 3462 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 3463 | }, |
| 3464 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 3465 | }, |
| 3466 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 3467 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| 3468 | { |
| 3469 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3470 | }, |
| 3471 | ], |
| 3472 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 3473 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 3474 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 3475 | { |
| 3476 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3477 | }, |
| 3478 | ], |
| 3479 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 3480 | }, |
| 3481 | }, |
| 3482 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 3483 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 3484 | "id": "A String", # id is the id of the slsa provenance builder |
| 3485 | }, |
| 3486 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 3487 | { # Material is a material used in the generation of the provenance |
| 3488 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 3489 | "a_key": "A String", |
| 3490 | }, |
| 3491 | "uri": "A String", # uri is the uri of the material |
| 3492 | }, |
| 3493 | ], |
| 3494 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 3495 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 3496 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 3497 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 3498 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 3499 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 3500 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 3501 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 3502 | }, |
| 3503 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 3504 | }, |
| 3505 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 3506 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 3507 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3508 | }, |
| 3509 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 3510 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 3511 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 3512 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3513 | }, |
| 3514 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 3515 | }, |
| 3516 | }, |
| 3517 | "subject": [ # subject is the subjects of the intoto statement |
| 3518 | { # Subject refers to the subject of the intoto statement |
| 3519 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| 3520 | "a_key": "A String", |
| 3521 | }, |
| 3522 | "name": "A String", # name is the name of the Subject used here |
| 3523 | }, |
| 3524 | ], |
| 3525 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3526 | "provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance |
| 3527 | "buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details. |
| 3528 | "a_key": "A String", |
| 3529 | }, |
| 3530 | "builderVersion": "A String", # Version string of the builder at the time this build was executed. |
| 3531 | "builtArtifacts": [ # Output of the build. |
| 3532 | { # Artifact describes a build product. |
| 3533 | "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container. |
| 3534 | "id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456 |
| 3535 | "name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto. |
| 3536 | "names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image. |
| 3537 | "A String", |
| 3538 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 3539 | }, |
| 3540 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3541 | "commands": [ # Commands requested by the build. |
| 3542 | { # Command describes a step performed as part of the build pipeline. |
| 3543 | "args": [ # Command-line arguments used when executing this Command. |
| 3544 | "A String", |
| 3545 | ], |
| 3546 | "dir": "A String", # Working directory (relative to project source root) used when running this Command. |
| 3547 | "env": [ # Environment variables set before running this Command. |
| 3548 | "A String", |
| 3549 | ], |
| 3550 | "id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency. |
| 3551 | "name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`. |
| 3552 | "waitFor": [ # The ID(s) of the Command(s) that this Command depends on. |
| 3553 | "A String", |
| 3554 | ], |
| 3555 | }, |
| 3556 | ], |
| 3557 | "createTime": "A String", # Time at which the build was created. |
| 3558 | "creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time. |
| 3559 | "finishTime": "A String", # Time at which execution of the build was finished. |
| 3560 | "id": "A String", # Unique identifier of the build. |
| 3561 | "logsBucket": "A String", # Google Cloud Storage bucket where logs were written. |
| 3562 | "projectId": "A String", # ID of the project. |
| 3563 | "sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build. |
| 3564 | "additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field. |
| 3565 | { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3566 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3567 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 3568 | "kind": "A String", # The alias kind. |
| 3569 | "name": "A String", # The alias name. |
| 3570 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3571 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3572 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 3573 | "projectId": "A String", # The ID of the project. |
| 3574 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 3575 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3576 | "uid": "A String", # A server-assigned, globally unique identifier. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3577 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3578 | "revisionId": "A String", # A revision ID. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3579 | }, |
| 3580 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3581 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 3582 | "kind": "A String", # The alias kind. |
| 3583 | "name": "A String", # The alias name. |
| 3584 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3585 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3586 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 3587 | "revisionId": "A String", # A revision (commit) ID. |
| 3588 | }, |
| 3589 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 3590 | "revisionId": "A String", # Required. Git commit hash. |
| 3591 | "url": "A String", # Git repository URL. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3592 | }, |
| 3593 | "labels": { # Labels with user defined metadata. |
| 3594 | "a_key": "A String", |
| 3595 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3596 | }, |
| 3597 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3598 | "artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location. |
| 3599 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 3600 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 3601 | "object": "A String", # Google Cloud Storage object containing source. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3602 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3603 | "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location. |
| 3604 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo. |
| 3605 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 3606 | "kind": "A String", # The alias kind. |
| 3607 | "name": "A String", # The alias name. |
| 3608 | }, |
| 3609 | "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo. |
| 3610 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 3611 | "projectId": "A String", # The ID of the project. |
| 3612 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 3613 | }, |
| 3614 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 3615 | }, |
| 3616 | "revisionId": "A String", # A revision ID. |
| 3617 | }, |
| 3618 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 3619 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 3620 | "kind": "A String", # The alias kind. |
| 3621 | "name": "A String", # The alias name. |
| 3622 | }, |
| 3623 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project. |
| 3624 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 3625 | "revisionId": "A String", # A revision (commit) ID. |
| 3626 | }, |
| 3627 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub). |
| 3628 | "revisionId": "A String", # Required. Git commit hash. |
| 3629 | "url": "A String", # Git repository URL. |
| 3630 | }, |
| 3631 | "labels": { # Labels with user defined metadata. |
| 3632 | "a_key": "A String", |
| 3633 | }, |
| 3634 | }, |
| 3635 | "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file. |
| 3636 | "a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build. |
| 3637 | "fileHash": [ # Collection of file hashes. |
| 3638 | { # Container message for hash values. |
| 3639 | "type": "A String", # The type of hash that was performed. |
| 3640 | "value": "A String", # The hash value. |
| 3641 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3642 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 3643 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3644 | }, |
| 3645 | "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo. |
| 3646 | "branchName": "A String", # Name of the branch to build. |
| 3647 | "commitSha": "A String", # Explicit commit SHA to build. |
| 3648 | "projectId": "A String", # ID of the project that owns the repo. |
| 3649 | "repoName": "A String", # Name of the repo. |
| 3650 | "tagName": "A String", # Name of the tag to build. |
| 3651 | }, |
| 3652 | "storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage. |
| 3653 | "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)). |
| 3654 | "generation": "A String", # Google Cloud Storage generation for the object. |
| 3655 | "object": "A String", # Google Cloud Storage object containing source. |
| 3656 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3657 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3658 | "startTime": "A String", # Time at which execution of the build was started. |
| 3659 | "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3660 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3661 | "provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes. |
| 3662 | }, |
| yoshi-code-bot | 26aa9e2 | 2021-06-10 00:24:06 -0700 | [diff] [blame] | 3663 | "compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes whether or not a resource passes compliance checks. |
| 3664 | "nonComplianceReason": "A String", # The reason for non compliance of these files. |
| 3665 | "nonCompliantFiles": [ # A list of files which are violating compliance checks. |
| 3666 | { # Details about files that caused a compliance check to fail. |
| 3667 | "displayCommand": "A String", # Command to display the non-compliant files. |
| 3668 | "path": "A String", # display_command is a single command that can be used to display a list of non compliant files. When there is no such command, we can also iterate a list of non compliant file using 'path'. Empty if `display_command` is set. |
| 3669 | "reason": "A String", # Explains why a file is non compliant for a CIS check. |
| 3670 | }, |
| 3671 | ], |
| 3672 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3673 | "createTime": "A String", # Output only. The time this `Occurrence` was created. |
| 3674 | "deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime. |
| 3675 | "address": "A String", # Address of the runtime element hosting this deployment. |
| 3676 | "config": "A String", # Configuration used to create this deployment. |
| 3677 | "deployTime": "A String", # Beginning of the lifetime of this deployment. |
| 3678 | "platform": "A String", # Platform hosting this deployment. |
| 3679 | "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name. |
| 3680 | "A String", |
| 3681 | ], |
| 3682 | "undeployTime": "A String", # End of the lifetime of this deployment. |
| 3683 | "userEmail": "A String", # Identity of the user that triggered this deployment. |
| 3684 | }, |
| 3685 | "derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note. |
| 3686 | "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence. |
| 3687 | "distance": 42, # Output only. The number of layers by which this image differs from the associated image basis. |
| 3688 | "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image. |
| 3689 | "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. |
| 3690 | "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] | 3691 | "A String", |
| 3692 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3693 | "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] | 3694 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3695 | "layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer. |
| 3696 | { # Layer holds metadata specific to a layer of a Docker image. |
| 3697 | "arguments": "A String", # The recovered arguments to the Dockerfile directive. |
| 3698 | "directive": "A String", # The recovered Dockerfile directive used to construct this layer. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 3699 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3700 | ], |
| 3701 | }, |
| 3702 | "discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource. |
| 3703 | "analysisStatus": "A String", # The status of discovery for the resource. |
| 3704 | "analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API. |
| 3705 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 3706 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 3707 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3708 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3709 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3710 | ], |
| 3711 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 3712 | }, |
| 3713 | "continuousAnalysis": "A String", # Whether the resource is continuously analyzed. |
| 3714 | "cpe": "A String", # The CPE of the resource being scanned. |
| 3715 | "operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use. |
| 3716 | "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| 3717 | "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 3718 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 3719 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 3720 | { |
| 3721 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3722 | }, |
| 3723 | ], |
| 3724 | "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| 3725 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3726 | "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| 3727 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3728 | }, |
| 3729 | "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| 3730 | "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| 3731 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3732 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 3733 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3734 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3735 | "dsseAttestation": { # An occurrence describing an attestation on a resource # This represents a DSSE attestation occurrence |
| 3736 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. |
| 3737 | "payload": "A String", # The bytes being signed |
| 3738 | "payloadType": "A String", # The type of payload being signed |
| 3739 | "signatures": [ # The signatures over the payload |
| 3740 | { # A DSSE signature |
| 3741 | "keyid": "A String", # A reference id to the key being used for signing |
| 3742 | "sig": "A String", # The signature itself |
| 3743 | }, |
| 3744 | ], |
| 3745 | }, |
| 3746 | "statement": { # Spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement The serialized InTotoStatement will be stored as Envelope.payload. Envelope.payloadType is always "application/vnd.in-toto+json". |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 3747 | "_type": "A String", # Always "https://in-toto.io/Statement/v0.1". |
| 3748 | "predicateType": "A String", # "https://slsa.dev/provenance/v0.1" for SlsaProvenance. |
| 3749 | "provenance": { # provenance is a predicate of type intotoprovenance |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3750 | "builderConfig": { # required |
| 3751 | "id": "A String", |
| 3752 | }, |
| 3753 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 3754 | "A String", |
| 3755 | ], |
| 3756 | "metadata": { # Other properties of the build. |
| 3757 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 3758 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 3759 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 3760 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 3761 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 3762 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 3763 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 3764 | }, |
| 3765 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 3766 | }, |
| 3767 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). required |
| 3768 | "arguments": [ # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 3769 | { |
| 3770 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3771 | }, |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3772 | ], |
| 3773 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 3774 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 3775 | "environment": [ # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. |
| 3776 | { |
| 3777 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3778 | }, |
| 3779 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3780 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 3781 | }, |
| 3782 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 3783 | "slsaProvenance": { # SlsaProvenance is the slsa provenance as defined by the slsa spec. # slsa_provenance is a predicate of type slsaProvenance |
| 3784 | "builder": { # SlsaBuilder encapsulates the identity of the builder of this provenance. # builder is the builder of this provenance |
| 3785 | "id": "A String", # id is the id of the slsa provenance builder |
| 3786 | }, |
| 3787 | "materials": [ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty. |
| 3788 | { # Material is a material used in the generation of the provenance |
| 3789 | "digest": { # digest is a map from a hash algorithm (e.g. sha256) to the value in the material |
| 3790 | "a_key": "A String", |
| 3791 | }, |
| 3792 | "uri": "A String", # uri is the uri of the material |
| 3793 | }, |
| 3794 | ], |
| 3795 | "metadata": { # Other properties of the build. # metadata is the metadata of the provenance |
| 3796 | "buildFinishedOn": "A String", # The timestamp of when the build completed. |
| 3797 | "buildInvocationId": "A String", # Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec. |
| 3798 | "buildStartedOn": "A String", # The timestamp of when the build started. |
| 3799 | "completeness": { # Indicates that the builder claims certain fields in this message to be complete. # Indicates that the builder claims certain fields in this message to be complete. |
| 3800 | "arguments": True or False, # If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe. |
| 3801 | "environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete. |
| 3802 | "materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic". |
| 3803 | }, |
| 3804 | "reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output. |
| 3805 | }, |
| 3806 | "recipe": { # Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe. # Identifies the configuration used for the build. When combined with materials, this SHOULD fully describe the build, such that re-running this recipe results in bit-for-bit identical output (if the build is reproducible). |
| 3807 | "arguments": { # Collection of all external inputs that influenced the build on top of recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe type were "make", then this might be the flags passed to make aside from the target, which is captured in recipe.entryPoint. Depending on the recipe Type, the structure may be different. |
| 3808 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3809 | }, |
| 3810 | "definedInMaterial": "A String", # Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64. |
| 3811 | "entryPoint": "A String", # String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use. |
| 3812 | "environment": { # Any other builder-controlled inputs necessary for correctly evaluating the recipe. Usually only needed for reproducing the build but not evaluated as part of policy. Depending on the recipe Type, the structure may be different. |
| 3813 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 3814 | }, |
| 3815 | "type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials. |
| 3816 | }, |
| 3817 | }, |
| 3818 | "subject": [ # subject is the subjects of the intoto statement |
| 3819 | { # Subject refers to the subject of the intoto statement |
| 3820 | "digest": { # "": "" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3821 | "a_key": "A String", |
| 3822 | }, |
| yoshi-code-bot | 815c1ac | 2021-11-15 23:24:17 -0800 | [diff] [blame] | 3823 | "name": "A String", # name is the name of the Subject used here |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3824 | }, |
| 3825 | ], |
| yoshi-code-bot | 3e4b5db | 2021-08-10 00:22:29 -0700 | [diff] [blame] | 3826 | }, |
| 3827 | }, |
| 3828 | "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # https://github.com/secure-systems-lab/dsse |
| 3829 | "payload": "A String", # The bytes being signed |
| 3830 | "payloadType": "A String", # The type of payload being signed |
| 3831 | "signatures": [ # The signatures over the payload |
| 3832 | { # A DSSE signature |
| 3833 | "keyid": "A String", # A reference id to the key being used for signing |
| 3834 | "sig": "A String", # The signature itself |
| 3835 | }, |
| 3836 | ], |
| 3837 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3838 | "installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource. |
| 3839 | "location": [ # All of the places within the filesystem versions of this package have been found. |
| 3840 | { # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status |
| 3841 | "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. |
| 3842 | "path": "A String", # The path from which we gathered that this package/version is installed. |
| 3843 | "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 installed at this location. |
| 3844 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 3845 | "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] | 3846 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 3847 | "name": "A String", # The main part of the version name. |
| 3848 | "revision": "A String", # The iteration of the package build from the above version. |
| 3849 | }, |
| 3850 | }, |
| 3851 | ], |
| 3852 | "name": "A String", # Output only. The name of the installed package. |
| 3853 | }, |
| 3854 | "kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests. |
| 3855 | "name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" |
| 3856 | "noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests. |
| 3857 | "remediation": "A String", # A description of actions that can be taken to remedy the `Note` |
| 3858 | "resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies. |
| 3859 | "contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest. |
| 3860 | "type": "A String", # The type of hash that was performed. |
| 3861 | "value": "A String", # The hash value. |
| 3862 | }, |
| 3863 | "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian". |
| 3864 | "uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image. |
| 3865 | }, |
| 3866 | "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3867 | "sbom": { # DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # Describes a specific software bill of materials document. |
| 3868 | "createTime": "A String", # Identify when the SPDX file was originally created. The date is to be specified according to combined date and time in UTC format as specified in ISO 8601 standard |
| 3869 | "creatorComment": "A String", # A field for creators of the SPDX file to provide general comments about the creation of the SPDX file or any other relevant comment not included in the other fields |
| 3870 | "creators": [ # Identify who (or what, in the case of a tool) created the SPDX file. If the SPDX file was created by an individual, indicate the person's name |
| 3871 | "A String", |
| 3872 | ], |
| 3873 | "documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document |
| 3874 | "externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document |
| 3875 | "A String", |
| 3876 | ], |
| 3877 | "id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally |
| 3878 | "licenseListVersion": "A String", # A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created |
| 3879 | "namespace": "A String", # Provide an SPDX document specific namespace as a unique absolute Uniform Resource Identifier (URI) as specified in RFC-3986, with the exception of the ‘#’ delimiter |
| 3880 | "title": "A String", # Identify name of this document as designated by creator |
| 3881 | }, |
| 3882 | "spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File. |
| 3883 | "attributions": [ # This field provides a place for the SPDX data creator to record, at the file level, acknowledgements that may be needed to be communicated in some contexts |
| 3884 | "A String", |
| 3885 | ], |
| 3886 | "comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file |
| 3887 | "contributors": [ # This field provides a place for the SPDX file creator to record file contributors |
| 3888 | "A String", |
| 3889 | ], |
| 3890 | "copyright": "A String", # Identify the copyright holder of the file, as well as any dates present |
| 3891 | "filesLicenseInfo": [ # This field contains the license information actually found in the file, if any |
| 3892 | "A String", |
| 3893 | ], |
| 3894 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3895 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # This field contains the license the SPDX file creator has concluded as governing the file or alternative values if the governing license cannot be determined |
| 3896 | "comments": "A String", # Comments |
| 3897 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 3898 | }, |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3899 | "notice": "A String", # This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file |
| 3900 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3901 | "spdxPackage": { # PackageInfoOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3902 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described |
| 3903 | "filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3904 | "homePage": "A String", # Output only. Provide a place for the SPDX file creator to record a web site that serves as the package's home page |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3905 | "id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3906 | "licenseConcluded": { # License information: https://spdx.github.io/spdx-spec/3-package-information/#315-declared-license # package or alternative values, if the governing license cannot be determined |
| 3907 | "comments": "A String", # Comments |
| 3908 | "expression": "A String", # Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-expressions/ |
| 3909 | }, |
| 3910 | "packageType": "A String", # Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc. |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3911 | "sourceInfo": "A String", # Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3912 | "summaryDescription": "A String", # Output only. A short description of the package |
| 3913 | "title": "A String", # Output only. Identify the full name of the package as given by the Package Originator |
| 3914 | "version": "A String", # Output only. Identify the version of the package |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3915 | }, |
| 3916 | "spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific relationship between SPDX elements. |
| 3917 | "comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship |
| 3918 | "source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc) |
| 3919 | "target": "A String", # Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In cases where there are "known unknowns", the use of the keyword NOASSERTION can be used The keywords NONE can be used to indicate that an SPDX element (package/file/snippet) has no other elements connected by some relationship to it |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3920 | "type": "A String", # Output only. The type of relationship between the source and target SPDX elements |
| yoshi-code-bot | b539cc4 | 2021-08-03 00:20:27 -0700 | [diff] [blame] | 3921 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3922 | "updateTime": "A String", # Output only. The time this `Occurrence` was last updated. |
| 3923 | "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade. |
| 3924 | "distribution": { # 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. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence. |
| 3925 | "classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. |
| 3926 | "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/. |
| 3927 | "cve": [ # The cve that would be resolved by this upgrade. |
| 3928 | "A String", |
| 3929 | ], |
| 3930 | "severity": "A String", # The severity as specified by the upstream operating system. |
| 3931 | }, |
| 3932 | "package": "A String", # Required - The package this Upgrade is for. |
| 3933 | "parsedVersion": { # 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 a machine + human readable form. |
| 3934 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 3935 | "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] | 3936 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 3937 | "name": "A String", # The main part of the version name. |
| 3938 | "revision": "A String", # The iteration of the package build from the above version. |
| 3939 | }, |
| 3940 | }, |
| 3941 | "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note. |
| 3942 | "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 3943 | "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple package issues for this vulnerability, they can have different effective severities because some might come from the distro and some might come from installed language packs (e.g. Maven JARs or Go binaries). For this reason, it is advised to use the effective severity on the PackageIssue level, as this field may eventually be deprecated. In the case where multiple PackageIssues have different effective severities, the one set here will be the highest severity of any of the PackageIssues. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3944 | "packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource. |
| 3945 | { # This message wraps a location affected by a vulnerability and its associated fix (if one is available). |
| 3946 | "affectedLocation": { # The location of the vulnerability # The location of the vulnerability. |
| 3947 | "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. |
| 3948 | "package": "A String", # The package being described. |
| 3949 | "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. |
| 3950 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 3951 | "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] | 3952 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 3953 | "name": "A String", # The main part of the version name. |
| 3954 | "revision": "A String", # The iteration of the package build from the above version. |
| 3955 | }, |
| 3956 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 3957 | "effectiveSeverity": "A String", # Output only. The distro or language system assigned severity for this vulnerability when that is available and note provider assigned severity when distro or language system has not yet assigned a severity for this vulnerability. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3958 | "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability. |
| 3959 | "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. |
| 3960 | "package": "A String", # The package being described. |
| 3961 | "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. |
| 3962 | "epoch": 42, # Used to correct mistakes in the version numbering scheme. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 3963 | "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] | 3964 | "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. |
| 3965 | "name": "A String", # The main part of the version name. |
| 3966 | "revision": "A String", # The iteration of the package build from the above version. |
| 3967 | }, |
| 3968 | }, |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 3969 | "packageType": "A String", # The type of package (e.g. OS, MAVEN, GO). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3970 | "severityName": "A String", |
| 3971 | }, |
| 3972 | ], |
| 3973 | "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability. |
| yoshi-code-bot | 8bb904c | 2021-08-31 00:28:27 -0700 | [diff] [blame] | 3974 | "type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc). This may be deprecated in the future because we can have multiple PackageIssues with different package types. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3975 | }, |
| 3976 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3977 | </div> |
| 3978 | |
| 3979 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 3980 | <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] | 3981 | <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] | 3982 | |
| 3983 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 3984 | 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] | 3985 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 3986 | The object takes the form of: |
| 3987 | |
| 3988 | { # Request message for `SetIamPolicy` method. |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3989 | "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. |
| 3990 | "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. |
| 3991 | { # Associates `members`, or principals, with a `role`. |
| 3992 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3993 | "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. |
| 3994 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 3995 | "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. |
| 3996 | "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] | 3997 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 3998 | "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 3999 | "A String", |
| 4000 | ], |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 4001 | "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 4002 | }, |
| 4003 | ], |
| 4004 | "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. |
| 4005 | "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). |
| 4006 | }, |
| 4007 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4008 | |
| 4009 | x__xgafv: string, V1 error format. |
| 4010 | Allowed values |
| 4011 | 1 - v1 error format |
| 4012 | 2 - v2 error format |
| 4013 | |
| 4014 | Returns: |
| 4015 | An object of the form: |
| 4016 | |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 4017 | { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| 4018 | "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. |
| 4019 | { # Associates `members`, or principals, with a `role`. |
| 4020 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 4021 | "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. |
| 4022 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 4023 | "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. |
| 4024 | "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] | 4025 | }, |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 4026 | "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 4027 | "A String", |
| 4028 | ], |
| yoshi-code-bot | 12d387c | 2021-10-26 00:24:32 -0700 | [diff] [blame] | 4029 | "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 4030 | }, |
| 4031 | ], |
| 4032 | "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. |
| 4033 | "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). |
| 4034 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4035 | </div> |
| 4036 | |
| 4037 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 4038 | <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] | 4039 | <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] | 4040 | |
| 4041 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 4042 | 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] | 4043 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4044 | The object takes the form of: |
| 4045 | |
| 4046 | { # Request message for `TestIamPermissions` method. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 4047 | "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). |
| 4048 | "A String", |
| 4049 | ], |
| 4050 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4051 | |
| 4052 | x__xgafv: string, V1 error format. |
| 4053 | Allowed values |
| 4054 | 1 - v1 error format |
| 4055 | 2 - v2 error format |
| 4056 | |
| 4057 | Returns: |
| 4058 | An object of the form: |
| 4059 | |
| 4060 | { # Response message for `TestIamPermissions` method. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 4061 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 4062 | "A String", |
| 4063 | ], |
| 4064 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 4065 | </div> |
| 4066 | |
| 4067 | </body></html> |