/
containeranalysis_v1beta1.projects.notes.html
2418 lines (2350 loc) · 279 KB
/
containeranalysis_v1beta1.projects.notes.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_v1beta1.html">Container Analysis API</a> . <a href="containeranalysis_v1beta1.projects.html">projects</a> . <a href="containeranalysis_v1beta1.projects.notes.html">notes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="containeranalysis_v1beta1.projects.notes.occurrences.html">occurrences()</a></code>
</p>
<p class="firstline">Returns the occurrences Resource.</p>
<p class="toc_element">
<code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates new notes 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, noteId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new note.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified note.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified note.</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="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists notes 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 note.</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 notes in batch.
Args:
parent: string, Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created. (required)
body: object, The request body.
The object takes the form of:
{ # Request to create notes in batch.
"notes": { # Required. The notes to create, the key is expected to be the note ID. Max allowed length is 1000.
"a_key": { # A type of analysis that can be done for a resource.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
},
},
"baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base 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.
},
"resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
},
"build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
"keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
"publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
"signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
},
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
"resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
},
"discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
"analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
"expectedCommand": [ # This field contains the expected command used to perform the step.
"A String",
],
"expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
{ # Defines an object to declare an in-toto artifact rule
"artifactRule": [
"A String",
],
},
],
"expectedProducts": [
{ # Defines an object to declare an in-toto artifact rule
"artifactRule": [
"A String",
],
},
],
"signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
{ # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
"keyId": "A String", # key_id is an identifier for the signing key.
"keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
"keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
"publicKeyValue": "A String", # This field contains the actual public key.
},
],
"stepName": "A String", # This field identifies the name of the step in the supply chain.
"threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
"longDescription": "A String", # A detailed description of this note.
"name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"package": { # Package represents a particular package version. # A note describing a package hosted by various package managers.
"architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # 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.
"description": "A String", # The description of this package.
"digest": [ # Hash value, typically a file digest, that allows unique identification a specific package.
{ # Digest information.
"algo": "A String", # `SHA1`, `SHA512` etc.
"digestBytes": "A String", # Value of the digest.
},
],
"distribution": [ # The various channels by which a package is distributed.
{ # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
"architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
"cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
"description": "A String", # The distribution channel-specific description of this package.
"latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
"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.
},
"maintainer": "A String", # A freeform string denoting the maintainer of this package.
"url": "A String", # The distribution channel-specific homepage for this package.
},
],
"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".
},
"maintainer": "A String", # A freeform text denoting the maintainer of this package.
"name": "A String", # Required. Immutable. The name of the package.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"url": "A String", # The homepage for this package.
"version": { # Version contains structured information about the version of a package. # 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.
},
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"relatedUrl": [ # URLs associated with this note.
{ # 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.
},
],
"sbom": { # DocumentNote represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing a software bill of materials.
"dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata")
"spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file
},
"shortDescription": "A String", # A one sentence description of this note.
"spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File.
"checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package
"A String",
],
"fileType": "A String", # This field provides information about the type of file identified
"title": "A String", # Identify the full path and filename that corresponds to the file information in this section
},
"spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package.
"analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document
"attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts
"checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file
"copyright": "A String", # Identify the copyright holders of the package, as well as any dates present
"detailedDescription": "A String", # A more detailed description of the package
"downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created
"externalRefs": [ # ExternalRef
{ # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package
"category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package
"comment": "A String", # Human-readable information about the purpose and target of the reference
"locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location
"type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category)
},
],
"filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found
"A String",
],
"homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page
"licenseDeclared": { # License information. # List the 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".
},
"originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came
"packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc.
"summaryDescription": "A String", # A short description of the package
"supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file
"title": "A String", # Identify the full name of the package as given by the Package Originator
"verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file
"version": "A String", # Identify the version of the package
},
"spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing an SPDX File.
"type": "A String", # The type of relationship between the source and target SPDX elements
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2
"authentication": "A String", # Defined in CVSS v2
"availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String", # Defined in CVSS v3, CVSS v2
"privilegesRequired": "A String", # Defined in CVSS v3
"scope": "A String", # Defined in CVSS v3
"userInteraction": "A String", # Defined in CVSS v3
},
"cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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",
},
"cvssVersion": "A String", # CVSS version used to populate cvss_score and severity.
"cwe": [ # A list of CWE for this vulnerability. For details, see: https://cwe.mitre.org/index.html
"A String",
],
"details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
{ # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
"description": "A String", # A vendor-specific description of this note.
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"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.
},
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"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.
},
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
"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.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"source": "A String", # The source from which the information in this Detail was obtained.
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
"vendor": "A String", # The name of the vendor of the product.
},
],
"severity": "A String", # Note provider assigned impact of the vulnerability.
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
"windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
{
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
"description": "A String", # The description of the vulnerability.
"fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
},
],
"name": "A String", # Required. The name of the vulnerability.
},
],
},
},
},
}
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 notes in batch.
"notes": [ # The notes that were created.
{ # A type of analysis that can be done for a resource.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
},
},
"baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base 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.
},
"resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
},
"build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
"keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
"publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
"signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
},
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
"resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
},
"discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
"analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
"expectedCommand": [ # This field contains the expected command used to perform the step.
"A String",
],
"expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
{ # Defines an object to declare an in-toto artifact rule
"artifactRule": [
"A String",
],
},
],
"expectedProducts": [
{ # Defines an object to declare an in-toto artifact rule
"artifactRule": [
"A String",
],
},
],
"signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
{ # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
"keyId": "A String", # key_id is an identifier for the signing key.
"keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
"keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
"publicKeyValue": "A String", # This field contains the actual public key.
},
],
"stepName": "A String", # This field identifies the name of the step in the supply chain.
"threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
"longDescription": "A String", # A detailed description of this note.
"name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"package": { # Package represents a particular package version. # A note describing a package hosted by various package managers.
"architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # 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.
"description": "A String", # The description of this package.
"digest": [ # Hash value, typically a file digest, that allows unique identification a specific package.
{ # Digest information.
"algo": "A String", # `SHA1`, `SHA512` etc.
"digestBytes": "A String", # Value of the digest.
},
],
"distribution": [ # The various channels by which a package is distributed.
{ # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
"architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
"cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
"description": "A String", # The distribution channel-specific description of this package.
"latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
"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.
},
"maintainer": "A String", # A freeform string denoting the maintainer of this package.
"url": "A String", # The distribution channel-specific homepage for this package.
},
],
"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".
},
"maintainer": "A String", # A freeform text denoting the maintainer of this package.
"name": "A String", # Required. Immutable. The name of the package.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"url": "A String", # The homepage for this package.
"version": { # Version contains structured information about the version of a package. # 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.
},
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"relatedUrl": [ # URLs associated with this note.
{ # 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.
},
],
"sbom": { # DocumentNote represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing a software bill of materials.
"dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata")
"spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file
},
"shortDescription": "A String", # A one sentence description of this note.
"spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File.
"checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package
"A String",
],
"fileType": "A String", # This field provides information about the type of file identified
"title": "A String", # Identify the full path and filename that corresponds to the file information in this section
},
"spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package.
"analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document
"attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts
"checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file
"copyright": "A String", # Identify the copyright holders of the package, as well as any dates present
"detailedDescription": "A String", # A more detailed description of the package
"downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created
"externalRefs": [ # ExternalRef
{ # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package
"category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package
"comment": "A String", # Human-readable information about the purpose and target of the reference
"locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location
"type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category)
},
],
"filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found
"A String",
],
"homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page
"licenseDeclared": { # License information. # List the 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".
},
"originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came
"packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc.
"summaryDescription": "A String", # A short description of the package
"supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file
"title": "A String", # Identify the full name of the package as given by the Package Originator
"verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file
"version": "A String", # Identify the version of the package
},
"spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing an SPDX File.
"type": "A String", # The type of relationship between the source and target SPDX elements
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2
"authentication": "A String", # Defined in CVSS v2
"availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String", # Defined in CVSS v3, CVSS v2
"privilegesRequired": "A String", # Defined in CVSS v3
"scope": "A String", # Defined in CVSS v3
"userInteraction": "A String", # Defined in CVSS v3
},
"cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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",
},
"cvssVersion": "A String", # CVSS version used to populate cvss_score and severity.
"cwe": [ # A list of CWE for this vulnerability. For details, see: https://cwe.mitre.org/index.html
"A String",
],
"details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
{ # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
"description": "A String", # A vendor-specific description of this note.
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"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.
},
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"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.
},
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
"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.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"source": "A String", # The source from which the information in this Detail was obtained.
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
"vendor": "A String", # The name of the vendor of the product.
},
],
"severity": "A String", # Note provider assigned impact of the vulnerability.
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
"windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
{
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
"description": "A String", # The description of the vulnerability.
"fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
},
],
"name": "A String", # Required. The name of the vulnerability.
},
],
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, noteId=None, x__xgafv=None)</code>
<pre>Creates a new note.
Args:
parent: string, Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created. (required)
body: object, The request body.
The object takes the form of:
{ # A type of analysis that can be done for a resource.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
},
},
"baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base 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.
},
"resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
},
"build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
"keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
"publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
"signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
},
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
"resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
},
"discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
"analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
"expectedCommand": [ # This field contains the expected command used to perform the step.
"A String",
],
"expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
{ # Defines an object to declare an in-toto artifact rule
"artifactRule": [
"A String",
],
},
],
"expectedProducts": [
{ # Defines an object to declare an in-toto artifact rule
"artifactRule": [
"A String",
],
},
],
"signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
{ # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
"keyId": "A String", # key_id is an identifier for the signing key.
"keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
"keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
"publicKeyValue": "A String", # This field contains the actual public key.
},
],
"stepName": "A String", # This field identifies the name of the step in the supply chain.
"threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
"longDescription": "A String", # A detailed description of this note.
"name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"package": { # Package represents a particular package version. # A note describing a package hosted by various package managers.
"architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # 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.
"description": "A String", # The description of this package.
"digest": [ # Hash value, typically a file digest, that allows unique identification a specific package.
{ # Digest information.
"algo": "A String", # `SHA1`, `SHA512` etc.
"digestBytes": "A String", # Value of the digest.
},
],
"distribution": [ # The various channels by which a package is distributed.
{ # This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror.
"architecture": "A String", # The CPU architecture for which packages in this distribution channel were built.
"cpeUri": "A String", # Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
"description": "A String", # The distribution channel-specific description of this package.
"latestVersion": { # Version contains structured information about the version of a package. # The latest available version of this package in this distribution channel.
"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.
},
"maintainer": "A String", # A freeform string denoting the maintainer of this package.
"url": "A String", # The distribution channel-specific homepage for this package.
},
],
"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".
},
"maintainer": "A String", # A freeform text denoting the maintainer of this package.
"name": "A String", # Required. Immutable. The name of the package.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"url": "A String", # The homepage for this package.
"version": { # Version contains structured information about the version of a package. # 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.
},
},
"relatedNoteNames": [ # Other notes related to this note.
"A String",
],
"relatedUrl": [ # URLs associated with this note.
{ # 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.
},
],
"sbom": { # DocumentNote represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/ # A note describing a software bill of materials.
"dataLicence": "A String", # Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata")
"spdxVersion": "A String", # Provide a reference number that can be used to understand how to parse and interpret the rest of the file
},
"shortDescription": "A String", # A one sentence description of this note.
"spdxFile": { # FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/ # A note describing an SPDX File.
"checksum": [ # Provide a unique identifier to match analysis information on each specific file in a package
"A String",
],
"fileType": "A String", # This field provides information about the type of file identified
"title": "A String", # Identify the full path and filename that corresponds to the file information in this section
},
"spdxPackage": { # PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/ # A note describing an SPDX Package.
"analyzed": True or False, # Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document
"attribution": "A String", # A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts
"checksum": "A String", # Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file
"copyright": "A String", # Identify the copyright holders of the package, as well as any dates present
"detailedDescription": "A String", # A more detailed description of the package
"downloadLocation": "A String", # This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created
"externalRefs": [ # ExternalRef
{ # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package
"category": "A String", # An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package
"comment": "A String", # Human-readable information about the purpose and target of the reference
"locator": "A String", # The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location
"type": "A String", # Type of category (e.g. 'npm' for the PACKAGE_MANAGER category)
},
],
"filesLicenseInfo": [ # Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found
"A String",
],
"homePage": "A String", # Provide a place for the SPDX file creator to record a web site that serves as the package's home page
"licenseDeclared": { # License information. # List the 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".
},
"originator": "A String", # If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came
"packageType": "A String", # The type of package: OS, MAVEN, GO, GO_STDLIB, etc.
"summaryDescription": "A String", # A short description of the package
"supplier": "A String", # Identify the actual distribution source for the package/directory identified in the SPDX file
"title": "A String", # Identify the full name of the package as given by the Package Originator
"verificationCode": "A String", # This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file
"version": "A String", # Identify the version of the package
},
"spdxRelationship": { # RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/ # A note describing an SPDX File.
"type": "A String", # The type of relationship between the source and target SPDX elements
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2
"authentication": "A String", # Defined in CVSS v2
"availabilityImpact": "A String", # Defined in CVSS v3, CVSS v2
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String", # Defined in CVSS v3, CVSS v2
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String", # Defined in CVSS v3, CVSS v2
"privilegesRequired": "A String", # Defined in CVSS v3
"scope": "A String", # Defined in CVSS v3
"userInteraction": "A String", # Defined in CVSS v3
},
"cvssV3": { # Deprecated. Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSS for version 3.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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",
},
"cvssVersion": "A String", # CVSS version used to populate cvss_score and severity.
"cwe": [ # A list of CWE for this vulnerability. For details, see: https://cwe.mitre.org/index.html
"A String",
],
"details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
{ # Identifies all appearances of this vulnerability in the package for a specific distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
"description": "A String", # A vendor-specific description of this note.
"fixedLocation": { # The location of the vulnerability. # The fix for this specific package version.
"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.
},
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"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.
},
"minAffectedVersion": { # Version contains structured information about the version of a package. # The min version of the package in which the vulnerability exists.
"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.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc).
"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.
"source": "A String", # The source from which the information in this Detail was obtained.
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
"vendor": "A String", # The name of the vendor of the product.
},
],
"severity": "A String", # Note provider assigned impact of the vulnerability.
"sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.
"windowsDetails": [ # Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version.
{
"cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar.
"description": "A String", # The description of the vulnerability.
"fixingKbs": [ # Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed kb's presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ i.e. KB123456).
"url": "A String", # A link to the KB in the Windows update catalog - https://www.catalog.update.microsoft.com/
},
],
"name": "A String", # Required. The name of the vulnerability.
},
],
},
}
noteId: string, Required. The ID to use for this note.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A type of analysis that can be done for a resource.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
},
},
"baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base 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.
},
"resourceUrl": "A String", # Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.
},
"build": { # Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. # A note describing build provenance for a verifiable build.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in occurrences pointing to this build note containing build details.
"keyId": "A String", # An ID for the key used to sign. This could be either an ID for the key stored in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`.
"publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
"signature": "A String", # Required. Signature of the related `BuildProvenance`. In JSON, this is base-64 encoded.
},
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
"resourceUri": [ # Required. Resource URI for the artifact being deployed.
"A String",
],
},
"discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. # A note describing the initial analysis of a resource.
"analysisKind": "A String", # Required. Immutable. The kind of analysis that is handled by this discovery.
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"intoto": { # This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. # A note describing an in-toto link.
"expectedCommand": [ # This field contains the expected command used to perform the step.
"A String",
],
"expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step.
{ # Defines an object to declare an in-toto artifact rule
"artifactRule": [
"A String",
],
},
],
"expectedProducts": [
{ # Defines an object to declare an in-toto artifact rule
"artifactRule": [
"A String",
],
},
],
"signingKeys": [ # This field contains the public keys that can be used to verify the signatures on the step metadata.
{ # This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification.
"keyId": "A String", # key_id is an identifier for the signing key.
"keyScheme": "A String", # This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256".
"keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa".
"publicKeyValue": "A String", # This field contains the actual public key.
},
],
"stepName": "A String", # This field identifies the name of the step in the supply chain.
"threshold": "A String", # This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in list requests.
"longDescription": "A String", # A detailed description of this note.
"name": "A String", # Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
"package": { # Package represents a particular package version. # A note describing a package hosted by various package managers.
"architecture": "A String", # The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
"cpeUri": "A String", # 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.
"description": "A String", # The description of this package.
"digest": [ # Hash value, typically a file digest, that allows unique identification a specific package.
{ # Digest information.
"algo": "A String", # `SHA1`, `SHA512` etc.