/
containeranalysis_v1beta1.projects.notes.occurrences.html
530 lines (507 loc) · 50.7 KB
/
containeranalysis_v1beta1.projects.notes.occurrences.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="containeranalysis_v1beta1.html">Container Analysis API</a> . <a href="containeranalysis_v1beta1.projects.html">projects</a> . <a href="containeranalysis_v1beta1.projects.notes.html">notes</a> . <a href="containeranalysis_v1beta1.projects.notes.occurrences.html">occurrences</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.
Args:
name: string, Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required)
filter: string, The filter expression.
pageSize: integer, Number of occurrences to return in the list.
pageToken: string, Token to provide to skip to a particular spot in the list.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for listing occurrences for a note.
"nextPageToken": "A String", # Token to provide to skip to a particular spot in the list.
"occurrences": [ # The occurrences attached to the specified note.
{ # An instance of an analysis type that has been found on a resource.
"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
"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 authority 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). # Required. Attestation for the resource.
"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message. This attestation must define the `serialized_payload` that the `signatures` verify and any metadata necessary to interpret that plaintext. The signatures should always be over the `serialized_payload` bytestring.
"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).
"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`. The encoding and semantic meaning of this payload must match what is set in `content_type`.
"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations should consider this attestation message verified if at least one `signature` verifies `serialized_payload`. See `Signature` in common.proto for more details on signature structure and verification.
{ # Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from `public_key_id` to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature `public_key_id` as anything more than a key lookup hint. The `public_key_id` DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The `public_key_id` is not recognized by the verifier. * The public key that `public_key_id` refers to does not verify the signature with respect to the payload. The `signature` contents SHOULD NOT be "attached" (where the payload is included with the serialized `signature` bytes). Verifiers MUST ignore any "attached" payload and only verify signatures with respect to explicitly provided payload (e.g. a `payload` field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature).
"publicKeyId": "A String", # The identifier for the public key that verifies this signature. * The `public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986 conformant URI. * When possible, the `public_key_id` SHOULD be an immutable reference, such as a cryptographic digest. Examples of valid `public_key_id`s: OpenPGP V4 public key fingerprint: * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
"signature": "A String", # The content of the signature, an opaque bytestring. The payload that this signature verifies MUST be unambiguously provided with the Signature during verification. A wrapper message might provide the payload explicitly. Alternatively, a message might have a canonical serialization that can always be unambiguously computed to derive the payload.
},
],
},
"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. # A PGP signed attestation.
"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).
"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`.
"signature": "A String", # Required. 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.
},
},
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # Required. The actual provenance for the build.
"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
"a_key": "A String",
},
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"builtArtifacts": [ # Output of the build.
{ # Artifact describes a build product.
"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.
"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like `gcr.io/projectID/imagename@sha256:123456`.
"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.
"A String",
],
},
],
"commands": [ # Commands requested by the build.
{ # Command describes a step performed as part of the build pipeline.
"args": [ # Command-line arguments used when executing this command.
"A String",
],
"dir": "A String", # Working directory (relative to project source root) used when running this command.
"env": [ # Environment variables set before running this command.
"A String",
],
"id": "A String", # Optional unique identifier for this command, used in wait_for to reference this command as a dependency.
"name": "A String", # Required. 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`.
"waitFor": [ # The ID(s) of the command(s) that this command depends on.
"A String",
],
},
],
"createTime": "A String", # Time at which the build was created.
"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.
"endTime": "A String", # Time at which execution of the build was finished.
"id": "A String", # Required. Unique identifier of the build.
"logsUri": "A String", # URI where any logs for this provenance were written.
"projectId": "A String", # ID of the project.
"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
"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.
{ # 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.
"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.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"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.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"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).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
],
"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this location.
"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.
"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.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
"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.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
"uid": "A String", # A server-assigned, globally unique identifier.
},
"revisionId": "A String", # A revision ID.
},
"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
"kind": "A String", # The alias kind.
"name": "A String", # The alias name.
},
"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.
"hostUri": "A String", # The URI of a running Gerrit instance.
"revisionId": "A String", # A revision (commit) ID.
},
"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).
"revisionId": "A String", # Git commit hash.
"url": "A String", # Git repository URL.
},
"labels": { # Labels with user defined metadata.
"a_key": "A String",
},
},
"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.
"a_key": { # Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
"fileHash": [ # Required. Collection of file hashes.
{ # Container message for hash values.
"type": "A String", # Required. The type of hash that was performed.
"value": "A String", # Required. The hash value.
},
],
},
},
},
"startTime": "A String", # Time at which execution of the build was started.
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
},
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. 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.
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
"address": "A String", # Address of the runtime element hosting this deployment.
"config": "A String", # Configuration used to create this deployment.
"deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
"platform": "A String", # Platform hosting this deployment.
"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
"A String",
],
"undeployTime": "A String", # End of the lifetime of this deployment.
"userEmail": "A String", # Identity of the user that triggered this deployment.
},
},
"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated note.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Required. Immutable. The child image derived from the base image.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.
"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1 representation.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
"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.
},
"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.
{ # Layer holds metadata specific to a layer of a Docker image.
"arguments": "A String", # The recovered arguments to the Dockerfile directive.
"directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.
},
],
},
},
"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
"analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.
"analysisType": [
"A String",
],
},
"analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.
{ # 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).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
],
"analysisStatus": "A String", # The status of discovery for the resource.
"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 is output only and populated by the API.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource. Deprecated, do not use.
},
},
"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
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
"installation": { # This represents how a particular software package may be installed on a system. # Required. Where the package was installed.
"architecture": "A String", # Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # Output only. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package. The cpe_uri will be blank for language packages.
"license": { # License information. # Licenses that have been declared by the authors of the package.
"comments": "A String", # Comments
"expression": "A String", # Often a single license can be used to represent the licensing terms. Sometimes it is necessary to include a choice of one or more licenses or some combination of license identifiers. Examples: "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later WITH Bison-exception-2.2".
},
"location": [ # All of the places within the filesystem versions of this package have been found.
{ # An occurrence of a particular package installation found within a system's filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
"cpeUri": "A String", # Deprecated. The CPE URI in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
"path": "A String", # The path from which we gathered that this package/version is installed.
"version": { # Version contains structured information about the version of a package. # Deprecated. The version installed at this location.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
],
"name": "A String", # Required. Output only. The name of the installed package.
"packageType": "A String", # Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"version": { # Version contains structured information about the version of a package. # Output only. The version of the package.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
},
"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. # Describes a specific in-toto link.
"signatures": [
{ # A signature object consists of the KeyID used and the signature itself.
"keyid": "A String",
"sig": "A String",
},
],
"signed": { # This corresponds to an in-toto link.
"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". # ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step.
"customValues": {
"a_key": "A String",
},
},
"command": [ # This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
"A String",
],
"environment": { # Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". # This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "", "filesystem": "", "workdir": "", "": "..." } }
"customValues": {
"a_key": "A String",
},
},
"materials": [ # Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", : } } ]
{
"hashes": { # Defines a hash object for use in Materials and Products.
"sha256": "A String",
},
"resourceUri": "A String",
},
],
"products": [ # Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials.
{
"hashes": { # Defines a hash object for use in Materials and Products.
"sha256": "A String",
},
"resourceUri": "A String",
},
],
},
},
"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.
"name": "A String", # Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead. The hash of the resource content. For example, the Docker digest.
"type": "A String", # Required. The type of hash that was performed.
"value": "A String", # Required. The hash value.
},
"name": "A String", # Deprecated, do not use. Use uri instead. The name of the resource. For example, the name of a Docker image - "Debian".
"uri": "A String", # Required. The unique URI of the resource. For example, `https://gcr.io/project/image@sha256:foo` for a Docker image.
},
"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.
"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
"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
"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
"A String",
],
"documentComment": "A String", # A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document
"externalDocumentRefs": [ # Identify any external SPDX documents referenced within this SPDX document
"A String",
],
"id": "A String", # Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally
"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
"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
"title": "A String", # Identify name of this document as designated by creator
},
"spdxFile": { # FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # Describes a specific SPDX File.
"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
"A String",
],
"comment": "A String", # This field provides a place for the SPDX file creator to record any general comments about the file
"contributors": [ # This field provides a place for the SPDX file creator to record file contributors
"A String",
],
"copyright": "A String", # Identify the copyright holder of the file, as well as any dates present
"filesLicenseInfo": [ # This field contains the license information actually found in the file, if any
"A String",
],
"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements
"licenseConcluded": { # License information. # 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
"comments": "A String", # Comments
"expression": "A String", # Often a single license can be used to represent the licensing terms. Sometimes it is necessary to include a choice of one or more licenses or some combination of license identifiers. Examples: "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later WITH Bison-exception-2.2".
},
"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
},
"spdxPackage": { # PackageInfoOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # Describes a specific SPDX Package.
"comment": "A String", # A place for the SPDX file creator to record any general comments about the package being described
"filename": "A String", # Provide the actual file name of the package, or path of the directory being treated as a package
"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
"id": "A String", # Uniquely identify any element in an SPDX document which may be referenced by other elements
"licenseConcluded": { # License information. # package or alternative values, if the governing license cannot be determined
"comments": "A String", # Comments
"expression": "A String", # Often a single license can be used to represent the licensing terms. Sometimes it is necessary to include a choice of one or more licenses or some combination of license identifiers. Examples: "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later WITH Bison-exception-2.2".
},
"packageType": "A String", # Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc.
"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
"summaryDescription": "A String", # Output only. A short description of the package
"title": "A String", # Output only. Identify the full name of the package as given by the Package Originator
"version": "A String", # Output only. Identify the version of the package
},
"spdxRelationship": { # RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # Describes a specific SPDX Relationship.
"comment": "A String", # A place for the SPDX file creator to record any general comments about the relationship
"source": "A String", # Also referred to as SPDXRef-A The source SPDX element (file, package, etc)
"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
"type": "A String", # Output only. The type of relationship between the source and target SPDX elements
},
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
"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.
"cvssVersion": "A String", # Output only. CVSS version used to populate cvss_score and severity.
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues.
"longDescription": "A String", # Output only. A detailed description of this vulnerability.
"packageIssue": [ # Required. The set of affected locations and their fixes (if available) within the associated resource.
{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).
"affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"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 it is not available.
"fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar.
"package": "A String", # Required. The package being described.
"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"packageType": "A String", # The type of package (e.g. OS, MAVEN, GO).
"severityName": "A String", # Deprecated, use Details.effective_severity instead The severity (e.g., distro assigned severity) for this vulnerability.
},
],
"relatedUrls": [ # Output only. URLs related to this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>