/
containeranalysis_v1.projects.occurrences.html
5859 lines (5784 loc) 路 622 KB
/
containeranalysis_v1.projects.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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<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_v1.html">Container Analysis API</a> . <a href="containeranalysis_v1.projects.html">projects</a> . <a href="containeranalysis_v1.projects.occurrences.html">occurrences</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates new occurrences in batch.</p>
<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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new occurrence.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified occurrence.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.</p>
<p class="toc_element">
<code><a href="#getNotes">getNotes(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.</p>
<p class="toc_element">
<code><a href="#getVulnerabilitySummary">getVulnerabilitySummary(parent, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a summary of the number and severity of occurrences.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists occurrences for the specified project.</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>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified occurrence.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
<pre>Creates new occurrences in batch.
Args:
parent: string, Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created. (required)
body: object, The request body.
The object takes the form of:
{ # Request to create occurrences in batch.
"occurrences": [ # Required. The occurrences to create. Max allowed length is 1000.
{ # An instance of an analysis type that has been found on a resource.
"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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"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.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"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.
"buildStartedOn": "A String", # The timestamp of when the build started.
"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.
"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.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"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
"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. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
"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.
"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. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"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.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"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.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"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.
"buildStartedOn": "A String", # The timestamp of when the build started.
"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.
"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.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"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
"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. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
"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.
"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. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"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.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"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.
"buildStartedOn": "A String", # The timestamp of when the build started.
"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.
"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.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"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
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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.
"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.
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # 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, e.g. "SHA-256".
"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.
},
"compliance": { # An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. # Describes a compliance violation on a linked resource.
"nonComplianceReason": "A String",
"nonCompliantFiles": [
{ # Details about files that caused a compliance check to fail. 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'.
"displayCommand": "A String", # Command to display the non-compliant files.
"path": "A String", # Empty if `display_command` is set.
"reason": "A String", # Explains why a file is non compliant for a CIS check.
},
],
},
"createTime": "A String", # Output only. The time this occurrence was created.
"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
"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.
},
"discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered.
"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.
},
"archiveTime": "A String", # Output only. The time occurrences related to this discovery occurrence were archived.
"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
"cpe": "A String", # The CPE of the resource being scanned.
"lastScanTime": "A String", # The last time this resource was scanned.
},
"dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse.
"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.
"payload": "A String",
"payloadType": "A String",
"signatures": [
{
"keyid": "A String",
"sig": "A String",
},
],
},
"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".
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"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.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"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.
"buildStartedOn": "A String", # The timestamp of when the build started.
"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.
"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.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"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
"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. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
"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.
"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. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"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.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"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.
"buildStartedOn": "A String", # The timestamp of when the build started.
"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.
"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.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"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
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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.
"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.
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
},
"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",
},
],
},
"image": { # Details of the derived image portion 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.
"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. See https://docs.docker.com/engine/reference/builder/ for more information.
},
],
},
"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.
"package": { # Details on how a particular software package was installed on a system. # Describes the installation of a package on the linked resource.
"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/)
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"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.
},
},
"remediation": "A String", # A description of actions that can be taken to remedy the note.
"resourceUri": "A String", # Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
"updateTime": "A String", # Output only. The time this occurrence was last updated.
"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). For Windows, both distribution and windows_update contain information for the Windows update. # Describes an available package upgrade on the linked resource.
"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.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"parsedVersion": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in a machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"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.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # An occurrence of a severity vulnerability on a resource. # 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.
"cvssv3": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The cvss v3 score for the vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. 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.
"fixAvailable": True or False, # Output only. Whether at least one of the affected packages has a fix available.
"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.
{ # A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was found in.
"affectedPackage": "A String", # Required. The package this vulnerability was found in.
"affectedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package that is installed on the resource affected by this vulnerability.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"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.
"fileLocation": [ # The location at which this package was found.
{ # Indicates the location at which a package was found.
"filePath": "A String", # For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file.
},
],
"fixAvailable": True or False, # Output only. Whether a fix is available for this package.
"fixedCpeUri": "A String", # The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability was fixed in. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The package this vulnerability was fixed in. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # Required. The version of the package this vulnerability was fixed in. Setting this to VersionKind.MAXIMUM means no fix is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"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).
},
],
"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 this 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 (e.g., ruby gems, node.js packages, etc.).
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for creating occurrences in batch.
"occurrences": [ # The occurrences that were created.
{ # An instance of an analysis type that has been found on a resource.
"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 lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. # Describes an attestation of an artifact.
"jwts": [ # One or more JWTs encoding a self-contained attestation. Each JWT encodes the payload that it verifies within the JWT itself. Verifier implementation SHOULD ignore the `serialized_payload` field when verifying these JWTs. If only JWTs are present on this AttestationOccurrence, then the `serialized_payload` SHOULD be left empty. Each JWT SHOULD encode a claim specific to the `resource_uri` of this Occurrence, but this is not validated by Grafeas metadata API implementations. The JWT itself is opaque to Grafeas.
{
"compactJwt": "A String", # The compact encoding of a JWS, which is always three base64 encoded strings joined by periods. For details, see: https://tools.ietf.org/html/rfc7515.html#section-3.1
},
],
"serializedPayload": "A String", # Required. The serialized payload that is verified by one or more `signatures`.
"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.
},
],
},
"build": { # Details of a build occurrence. # Describes a verifiable build.
"intotoProvenance": { # Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec.
"builderConfig": { # required
"id": "A String",
},
"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.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"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.
"buildStartedOn": "A String", # The timestamp of when the build started.
"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.
"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.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"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
"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. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
"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.
"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. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"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.
"_type": "A String", # Always `https://in-toto.io/Statement/v0.1`.
"predicateType": "A String", # `https://slsa.dev/provenance/v0.1` for SlsaProvenance.
"provenance": {
"builderConfig": { # required
"id": "A String",
},
"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.
"A String",
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"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.
"buildStartedOn": "A String", # The timestamp of when the build started.
"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.
"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.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"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
"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. Since the arguments field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
"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.
"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. Since the environment field can greatly vary in structure, depending on the builder and recipe type, this is of form "Any".
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenance": {
"builder": { # required
"id": "A String",
},
"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.
{
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String", # The timestamp of when the build completed.
"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.
"buildStartedOn": "A String", # The timestamp of when the build started.
"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.
"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.
"environment": True or False, # If true, the builder claims that recipe.environment is claimed to be complete.
"materials": True or False, # If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
},
"reproducible": True or False, # If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
},
"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
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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.
"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.
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"type": "A String", # URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
},
},
"slsaProvenanceZeroTwo": { # See full explanation of fields at slsa.dev/provenance/v0.2.
"buildConfig": {
"a_key": "", # Properties of the object.
},
"buildType": "A String",
"builder": { # Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.
"id": "A String",
},
"invocation": { # Identifies the event that kicked off the build.
"configSource": { # Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.
"digest": {
"a_key": "A String",
},
"entryPoint": "A String",
"uri": "A String",
},
"environment": {
"a_key": "", # Properties of the object.
},
"parameters": {
"a_key": "", # Properties of the object.
},
},
"materials": [
{ # The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.
"digest": {
"a_key": "A String",
},
"uri": "A String",
},
],
"metadata": { # Other properties of the build.
"buildFinishedOn": "A String",
"buildInvocationId": "A String",
"buildStartedOn": "A String",
"completeness": { # Indicates that the builder claims certain fields in this message to be complete.
"environment": True or False,
"materials": True or False,
"parameters": True or False,
},
"reproducible": True or False,
},
},
"subject": [
{
"digest": { # `"": ""` Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet
"a_key": "A String",
},
"name": "A String",
},
],
},
"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # 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.