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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="containeranalysis_v1.html">Container Analysis API</a> . <a href="containeranalysis_v1.projects.html">projects</a> . <a href="containeranalysis_v1.projects.locations.html">locations</a> . <a href="containeranalysis_v1.projects.locations.notes.html">notes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="containeranalysis_v1.projects.locations.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, returnPartialSuccess=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. Max allowed length is 1000.
"a_key": { # A type of analysis that can be done for a resource.
"attestation": { # 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".
},
},
"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.
},
"compliance": { # A note describing a compliance check.
"cisBenchmark": { # A compliance check that is a CIS benchmark.
"profileLevel": 42,
"severity": "A String",
},
"description": "A String", # A description about this compliance check.
"impact": "A String",
"rationale": "A String", # A rationale for the existence of this compliance check.
"remediation": "A String", # A description of remediation steps if the compliance check fails.
"scanInstructions": "A String", # Serialized scan instructions with a predefined format.
"title": "A String", # The title that identifies this compliance check.
"version": [ # The OS and config versions the benchmark applies to.
{ # Describes the CIS benchmark version that is applicable to a given OS and os version.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
],
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployment": { # 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.
},
"dsseAttestation": { # A note describing a dsse attestation note.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # DSSEHint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod".
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"image": { # 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.
},
"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": { # PackageNote 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": [ # Deprecated. 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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"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.
},
],
"sbomReference": { # The note representing an SBOM reference. # A note describing an SBOM reference.
"format": "A String", # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
"version": "A String", # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
},
"secret": { # The note representing a secret. # A note describing a secret.
},
"shortDescription": "A String", # A one sentence description of this note.
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. # A note describing available package upgrades.
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
],
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"version": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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.
"details": [ # Details of all known distros and packages affected by this vulnerability.
{ # A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
"affectedPackage": "A String", # Required. The package this vulnerability affects.
"affectedVersionEnd": { # Version contains structured information about the version of a package. # The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"affectedVersionStart": { # Version contains structured information about the version of a package. # The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"description": "A String", # A vendor-specific description of this vulnerability.
"fixedCpeUri": "A String", # The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"severityName": "A String", # The distro assigned severity of 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", # The note provider assigned severity of this 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](https://cpe.mitre.org/specification/) this vulnerability affects.
"description": "A String", # The description of this 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 KBs presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ (e.g., 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 this vulnerability.
},
],
},
"vulnerabilityAssessment": { # A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. # A note describing a vulnerability assessment.
"assessment": { # Assessment provides all information that is related to a single vulnerability for this product. # Represents a vulnerability assessment for the product.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"longDescription": "A String", # A detailed description of this Vex.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"shortDescription": "A String", # A one sentence description of this Vex.
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
"languageCode": "A String", # Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
"longDescription": "A String", # A detailed description of this Vex.
"product": { # Product contains information about a product and how to uniquely identify it. # The product affected by this vex.
"genericUri": "A String", # Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
"id": "A String", # Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document.
"name": "A String", # Name of the product.
},
"publisher": { # Publisher contains information about the publisher of this Note. # Publisher details of this Note.
"issuingAuthority": "A String", # Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
"name": "A String", # Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
"publisherNamespace": "A String", # The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io
},
"shortDescription": "A String", # A one sentence description of this Vex.
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
},
},
}
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.
"attestation": { # 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".
},
},
"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.
},
"compliance": { # A note describing a compliance check.
"cisBenchmark": { # A compliance check that is a CIS benchmark.
"profileLevel": 42,
"severity": "A String",
},
"description": "A String", # A description about this compliance check.
"impact": "A String",
"rationale": "A String", # A rationale for the existence of this compliance check.
"remediation": "A String", # A description of remediation steps if the compliance check fails.
"scanInstructions": "A String", # Serialized scan instructions with a predefined format.
"title": "A String", # The title that identifies this compliance check.
"version": [ # The OS and config versions the benchmark applies to.
{ # Describes the CIS benchmark version that is applicable to a given OS and os version.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
],
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployment": { # 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.
},
"dsseAttestation": { # A note describing a dsse attestation note.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # DSSEHint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod".
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"image": { # 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.
},
"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": { # PackageNote 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": [ # Deprecated. 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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"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.
},
],
"sbomReference": { # The note representing an SBOM reference. # A note describing an SBOM reference.
"format": "A String", # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
"version": "A String", # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
},
"secret": { # The note representing a secret. # A note describing a secret.
},
"shortDescription": "A String", # A one sentence description of this note.
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. # A note describing available package upgrades.
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
],
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"version": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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.
"details": [ # Details of all known distros and packages affected by this vulnerability.
{ # A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
"affectedPackage": "A String", # Required. The package this vulnerability affects.
"affectedVersionEnd": { # Version contains structured information about the version of a package. # The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"affectedVersionStart": { # Version contains structured information about the version of a package. # The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"description": "A String", # A vendor-specific description of this vulnerability.
"fixedCpeUri": "A String", # The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"severityName": "A String", # The distro assigned severity of 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", # The note provider assigned severity of this 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](https://cpe.mitre.org/specification/) this vulnerability affects.
"description": "A String", # The description of this 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 KBs presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ (e.g., 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 this vulnerability.
},
],
},
"vulnerabilityAssessment": { # A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. # A note describing a vulnerability assessment.
"assessment": { # Assessment provides all information that is related to a single vulnerability for this product. # Represents a vulnerability assessment for the product.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"longDescription": "A String", # A detailed description of this Vex.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"shortDescription": "A String", # A one sentence description of this Vex.
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
"languageCode": "A String", # Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
"longDescription": "A String", # A detailed description of this Vex.
"product": { # Product contains information about a product and how to uniquely identify it. # The product affected by this vex.
"genericUri": "A String", # Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
"id": "A String", # Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document.
"name": "A String", # Name of the product.
},
"publisher": { # Publisher contains information about the publisher of this Note. # Publisher details of this Note.
"issuingAuthority": "A String", # Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
"name": "A String", # Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
"publisherNamespace": "A String", # The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io
},
"shortDescription": "A String", # A one sentence description of this Vex.
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
},
],
}</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.
"attestation": { # 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".
},
},
"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.
},
"compliance": { # A note describing a compliance check.
"cisBenchmark": { # A compliance check that is a CIS benchmark.
"profileLevel": 42,
"severity": "A String",
},
"description": "A String", # A description about this compliance check.
"impact": "A String",
"rationale": "A String", # A rationale for the existence of this compliance check.
"remediation": "A String", # A description of remediation steps if the compliance check fails.
"scanInstructions": "A String", # Serialized scan instructions with a predefined format.
"title": "A String", # The title that identifies this compliance check.
"version": [ # The OS and config versions the benchmark applies to.
{ # Describes the CIS benchmark version that is applicable to a given OS and os version.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
],
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployment": { # 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.
},
"dsseAttestation": { # A note describing a dsse attestation note.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # DSSEHint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod".
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"image": { # 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.
},
"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": { # PackageNote 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": [ # Deprecated. 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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"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.
},
],
"sbomReference": { # The note representing an SBOM reference. # A note describing an SBOM reference.
"format": "A String", # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
"version": "A String", # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
},
"secret": { # The note representing a secret. # A note describing a secret.
},
"shortDescription": "A String", # A one sentence description of this note.
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. # A note describing available package upgrades.
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
],
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"version": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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.
"details": [ # Details of all known distros and packages affected by this vulnerability.
{ # A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
"affectedPackage": "A String", # Required. The package this vulnerability affects.
"affectedVersionEnd": { # Version contains structured information about the version of a package. # The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"affectedVersionStart": { # Version contains structured information about the version of a package. # The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"description": "A String", # A vendor-specific description of this vulnerability.
"fixedCpeUri": "A String", # The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"severityName": "A String", # The distro assigned severity of 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", # The note provider assigned severity of this 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](https://cpe.mitre.org/specification/) this vulnerability affects.
"description": "A String", # The description of this 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 KBs presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ (e.g., 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 this vulnerability.
},
],
},
"vulnerabilityAssessment": { # A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. # A note describing a vulnerability assessment.
"assessment": { # Assessment provides all information that is related to a single vulnerability for this product. # Represents a vulnerability assessment for the product.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"longDescription": "A String", # A detailed description of this Vex.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"shortDescription": "A String", # A one sentence description of this Vex.
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
"languageCode": "A String", # Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
"longDescription": "A String", # A detailed description of this Vex.
"product": { # Product contains information about a product and how to uniquely identify it. # The product affected by this vex.
"genericUri": "A String", # Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
"id": "A String", # Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document.
"name": "A String", # Name of the product.
},
"publisher": { # Publisher contains information about the publisher of this Note. # Publisher details of this Note.
"issuingAuthority": "A String", # Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
"name": "A String", # Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
"publisherNamespace": "A String", # The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io
},
"shortDescription": "A String", # A one sentence description of this Vex.
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
}
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.
"attestation": { # 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".
},
},
"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.
},
"compliance": { # A note describing a compliance check.
"cisBenchmark": { # A compliance check that is a CIS benchmark.
"profileLevel": 42,
"severity": "A String",
},
"description": "A String", # A description about this compliance check.
"impact": "A String",
"rationale": "A String", # A rationale for the existence of this compliance check.
"remediation": "A String", # A description of remediation steps if the compliance check fails.
"scanInstructions": "A String", # Serialized scan instructions with a predefined format.
"title": "A String", # The title that identifies this compliance check.
"version": [ # The OS and config versions the benchmark applies to.
{ # Describes the CIS benchmark version that is applicable to a given OS and os version.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
],
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployment": { # 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.
},
"dsseAttestation": { # A note describing a dsse attestation note.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # DSSEHint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod".
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"image": { # 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.
},
"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": { # PackageNote 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": [ # Deprecated. 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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"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.
},
],
"sbomReference": { # The note representing an SBOM reference. # A note describing an SBOM reference.
"format": "A String", # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
"version": "A String", # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
},
"secret": { # The note representing a secret. # A note describing a secret.
},
"shortDescription": "A String", # A one sentence description of this note.
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. # A note describing available package upgrades.
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
],
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"version": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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.
"details": [ # Details of all known distros and packages affected by this vulnerability.
{ # A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
"affectedPackage": "A String", # Required. The package this vulnerability affects.
"affectedVersionEnd": { # Version contains structured information about the version of a package. # The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"affectedVersionStart": { # Version contains structured information about the version of a package. # The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"description": "A String", # A vendor-specific description of this vulnerability.
"fixedCpeUri": "A String", # The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"severityName": "A String", # The distro assigned severity of 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", # The note provider assigned severity of this 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](https://cpe.mitre.org/specification/) this vulnerability affects.
"description": "A String", # The description of this 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 KBs presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ (e.g., 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 this vulnerability.
},
],
},
"vulnerabilityAssessment": { # A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. # A note describing a vulnerability assessment.
"assessment": { # Assessment provides all information that is related to a single vulnerability for this product. # Represents a vulnerability assessment for the product.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"longDescription": "A String", # A detailed description of this Vex.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"shortDescription": "A String", # A one sentence description of this Vex.
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
"languageCode": "A String", # Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
"longDescription": "A String", # A detailed description of this Vex.
"product": { # Product contains information about a product and how to uniquely identify it. # The product affected by this vex.
"genericUri": "A String", # Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
"id": "A String", # Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document.
"name": "A String", # Name of the product.
},
"publisher": { # Publisher contains information about the publisher of this Note. # Publisher details of this Note.
"issuingAuthority": "A String", # Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
"name": "A String", # Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
"publisherNamespace": "A String", # The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io
},
"shortDescription": "A String", # A one sentence description of this Vex.
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes the specified note.
Args:
name: string, Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets the specified note.
Args:
name: string, Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required)
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.
"attestation": { # 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".
},
},
"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.
},
"compliance": { # A note describing a compliance check.
"cisBenchmark": { # A compliance check that is a CIS benchmark.
"profileLevel": 42,
"severity": "A String",
},
"description": "A String", # A description about this compliance check.
"impact": "A String",
"rationale": "A String", # A rationale for the existence of this compliance check.
"remediation": "A String", # A description of remediation steps if the compliance check fails.
"scanInstructions": "A String", # Serialized scan instructions with a predefined format.
"title": "A String", # The title that identifies this compliance check.
"version": [ # The OS and config versions the benchmark applies to.
{ # Describes the CIS benchmark version that is applicable to a given OS and os version.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
],
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployment": { # 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.
},
"dsseAttestation": { # A note describing a dsse attestation note.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # DSSEHint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod".
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"image": { # 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.
},
"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": { # PackageNote 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": [ # Deprecated. 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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"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.
},
],
"sbomReference": { # The note representing an SBOM reference. # A note describing an SBOM reference.
"format": "A String", # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
"version": "A String", # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
},
"secret": { # The note representing a secret. # A note describing a secret.
},
"shortDescription": "A String", # A one sentence description of this note.
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. # A note describing available package upgrades.
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
],
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"version": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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.
"details": [ # Details of all known distros and packages affected by this vulnerability.
{ # A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
"affectedPackage": "A String", # Required. The package this vulnerability affects.
"affectedVersionEnd": { # Version contains structured information about the version of a package. # The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"affectedVersionStart": { # Version contains structured information about the version of a package. # The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"description": "A String", # A vendor-specific description of this vulnerability.
"fixedCpeUri": "A String", # The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"severityName": "A String", # The distro assigned severity of 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", # The note provider assigned severity of this 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](https://cpe.mitre.org/specification/) this vulnerability affects.
"description": "A String", # The description of this 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 KBs presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ (e.g., 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 this vulnerability.
},
],
},
"vulnerabilityAssessment": { # A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. # A note describing a vulnerability assessment.
"assessment": { # Assessment provides all information that is related to a single vulnerability for this product. # Represents a vulnerability assessment for the product.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"longDescription": "A String", # A detailed description of this Vex.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"shortDescription": "A String", # A one sentence description of this Vex.
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
"languageCode": "A String", # Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
"longDescription": "A String", # A detailed description of this Vex.
"product": { # Product contains information about a product and how to uniquely identify it. # The product affected by this vex.
"genericUri": "A String", # Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
"id": "A String", # Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document.
"name": "A String", # Name of the product.
},
"publisher": { # Publisher contains information about the publisher of this Note. # Publisher details of this Note.
"issuingAuthority": "A String", # Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
"name": "A String", # Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
"publisherNamespace": "A String", # The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io
},
"shortDescription": "A String", # A one sentence description of this Vex.
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
"requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
<pre>Lists notes for the specified project.
Args:
parent: string, Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. (required)
filter: string, The filter expression.
pageSize: integer, Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
pageToken: string, Token to provide to skip to a particular spot in the list.
returnPartialSuccess: boolean, If set, the request will return all reachable Notes and report all unreachable regions in the `unreachable` field in the response. Only applicable for requests in the global region.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for listing notes.
"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.
"notes": [ # The notes requested.
{ # A type of analysis that can be done for a resource.
"attestation": { # 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".
},
},
"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.
},
"compliance": { # A note describing a compliance check.
"cisBenchmark": { # A compliance check that is a CIS benchmark.
"profileLevel": 42,
"severity": "A String",
},
"description": "A String", # A description about this compliance check.
"impact": "A String",
"rationale": "A String", # A rationale for the existence of this compliance check.
"remediation": "A String", # A description of remediation steps if the compliance check fails.
"scanInstructions": "A String", # Serialized scan instructions with a predefined format.
"title": "A String", # The title that identifies this compliance check.
"version": [ # The OS and config versions the benchmark applies to.
{ # Describes the CIS benchmark version that is applicable to a given OS and os version.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
],
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployment": { # 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.
},
"dsseAttestation": { # A note describing a dsse attestation note.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # DSSEHint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod".
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"image": { # 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.
},
"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": { # PackageNote 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": [ # Deprecated. 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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"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.
},
],
"sbomReference": { # The note representing an SBOM reference. # A note describing an SBOM reference.
"format": "A String", # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
"version": "A String", # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
},
"secret": { # The note representing a secret. # A note describing a secret.
},
"shortDescription": "A String", # A one sentence description of this note.
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. # A note describing available package upgrades.
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
],
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"version": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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.
"details": [ # Details of all known distros and packages affected by this vulnerability.
{ # A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
"affectedPackage": "A String", # Required. The package this vulnerability affects.
"affectedVersionEnd": { # Version contains structured information about the version of a package. # The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"affectedVersionStart": { # Version contains structured information about the version of a package. # The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"description": "A String", # A vendor-specific description of this vulnerability.
"fixedCpeUri": "A String", # The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"severityName": "A String", # The distro assigned severity of 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", # The note provider assigned severity of this 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](https://cpe.mitre.org/specification/) this vulnerability affects.
"description": "A String", # The description of this 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 KBs presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ (e.g., 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 this vulnerability.
},
],
},
"vulnerabilityAssessment": { # A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. # A note describing a vulnerability assessment.
"assessment": { # Assessment provides all information that is related to a single vulnerability for this product. # Represents a vulnerability assessment for the product.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"longDescription": "A String", # A detailed description of this Vex.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"shortDescription": "A String", # A one sentence description of this Vex.
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
"languageCode": "A String", # Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
"longDescription": "A String", # A detailed description of this Vex.
"product": { # Product contains information about a product and how to uniquely identify it. # The product affected by this vex.
"genericUri": "A String", # Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
"id": "A String", # Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document.
"name": "A String", # Name of the product.
},
"publisher": { # Publisher contains information about the publisher of this Note. # Publisher details of this Note.
"issuingAuthority": "A String", # Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
"name": "A String", # Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
"publisherNamespace": "A String", # The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io
},
"shortDescription": "A String", # A one sentence description of this Vex.
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
},
],
"unreachable": [ # Unordered list. Unreachable regions. Populated for requests from the global region when `return_partial_success` is set. Format: `projects/[PROJECT_ID]/locations/[LOCATION]`
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the specified note.
Args:
name: string, Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required)
body: object, The request body.
The object takes the form of:
{ # A type of analysis that can be done for a resource.
"attestation": { # 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".
},
},
"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.
},
"compliance": { # A note describing a compliance check.
"cisBenchmark": { # A compliance check that is a CIS benchmark.
"profileLevel": 42,
"severity": "A String",
},
"description": "A String", # A description about this compliance check.
"impact": "A String",
"rationale": "A String", # A rationale for the existence of this compliance check.
"remediation": "A String", # A description of remediation steps if the compliance check fails.
"scanInstructions": "A String", # Serialized scan instructions with a predefined format.
"title": "A String", # The title that identifies this compliance check.
"version": [ # The OS and config versions the benchmark applies to.
{ # Describes the CIS benchmark version that is applicable to a given OS and os version.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
],
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployment": { # 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.
},
"dsseAttestation": { # A note describing a dsse attestation note.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # DSSEHint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod".
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"image": { # 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.
},
"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": { # PackageNote 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": [ # Deprecated. 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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"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.
},
],
"sbomReference": { # The note representing an SBOM reference. # A note describing an SBOM reference.
"format": "A String", # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
"version": "A String", # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
},
"secret": { # The note representing a secret. # A note describing a secret.
},
"shortDescription": "A String", # A one sentence description of this note.
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. # A note describing available package upgrades.
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
],
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"version": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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.
"details": [ # Details of all known distros and packages affected by this vulnerability.
{ # A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
"affectedPackage": "A String", # Required. The package this vulnerability affects.
"affectedVersionEnd": { # Version contains structured information about the version of a package. # The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"affectedVersionStart": { # Version contains structured information about the version of a package. # The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"description": "A String", # A vendor-specific description of this vulnerability.
"fixedCpeUri": "A String", # The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"severityName": "A String", # The distro assigned severity of 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", # The note provider assigned severity of this 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](https://cpe.mitre.org/specification/) this vulnerability affects.
"description": "A String", # The description of this 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 KBs presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ (e.g., 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 this vulnerability.
},
],
},
"vulnerabilityAssessment": { # A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. # A note describing a vulnerability assessment.
"assessment": { # Assessment provides all information that is related to a single vulnerability for this product. # Represents a vulnerability assessment for the product.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"longDescription": "A String", # A detailed description of this Vex.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"shortDescription": "A String", # A one sentence description of this Vex.
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
"languageCode": "A String", # Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
"longDescription": "A String", # A detailed description of this Vex.
"product": { # Product contains information about a product and how to uniquely identify it. # The product affected by this vex.
"genericUri": "A String", # Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
"id": "A String", # Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document.
"name": "A String", # Name of the product.
},
"publisher": { # Publisher contains information about the publisher of this Note. # Publisher details of this Note.
"issuingAuthority": "A String", # Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
"name": "A String", # Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
"publisherNamespace": "A String", # The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io
},
"shortDescription": "A String", # A one sentence description of this Vex.
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
}
updateMask: string, The fields to update.
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.
"attestation": { # 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".
},
},
"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.
},
"compliance": { # A note describing a compliance check.
"cisBenchmark": { # A compliance check that is a CIS benchmark.
"profileLevel": 42,
"severity": "A String",
},
"description": "A String", # A description about this compliance check.
"impact": "A String",
"rationale": "A String", # A rationale for the existence of this compliance check.
"remediation": "A String", # A description of remediation steps if the compliance check fails.
"scanInstructions": "A String", # Serialized scan instructions with a predefined format.
"title": "A String", # The title that identifies this compliance check.
"version": [ # The OS and config versions the benchmark applies to.
{ # Describes the CIS benchmark version that is applicable to a given OS and os version.
"benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS".
"cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.
"version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.
},
],
},
"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.
"deployment": { # 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.
},
"dsseAttestation": { # A note describing a dsse attestation note.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # DSSEHint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "cloudbuild-prod".
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
"image": { # 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.
},
"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": { # PackageNote 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": [ # Deprecated. 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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"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.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
},
"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.
},
],
"sbomReference": { # The note representing an SBOM reference. # A note describing an SBOM reference.
"format": "A String", # The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
"version": "A String", # The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.
},
"secret": { # The note representing a secret. # A note describing a secret.
},
"shortDescription": "A String", # A one sentence description of this note.
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. # A note describing available package upgrades.
"distributions": [ # Metadata about the upgrade for each specific operating system.
{ # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
"cve": [ # The cve tied to this Upgrade.
"A String",
],
"severity": "A String", # The severity as specified by the upstream operating system.
},
],
"package": "A String", # Required for non-Windows OS. The package this Upgrade is for.
"version": { # Version contains structured information about the version of a package. # Required for non-Windows OS. The version of the package in machine + human readable form.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"windowsUpdate": { # Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at https://docs.microsoft.com/en-us/windows/win32/api/wuapi/nn-wuapi-iupdate. # Required for Windows OS. Represents the metadata about the Windows update.
"categories": [ # The list of categories to which the update belongs.
{ # The category to which the update belongs.
"categoryId": "A String", # The identifier of the category.
"name": "A String", # The localized name of the category.
},
],
"description": "A String", # The localized description of the update.
"identity": { # The unique identifier of the update. # Required - The unique identifier for the update.
"revision": 42, # The revision number of the update.
"updateId": "A String", # The revision independent identifier of the update.
},
"kbArticleIds": [ # The Microsoft Knowledge Base article IDs that are associated with the update.
"A String",
],
"lastPublishedTimestamp": "A String", # The last published timestamp of the update.
"supportUrl": "A String", # The hyperlink to the support information for the update.
"title": "A String", # The localized title of the update.
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"authentication": "A String",
"availabilityImpact": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
"confidentialityImpact": "A String",
"exploitabilityScore": 3.14,
"impactScore": 3.14,
"integrityImpact": "A String",
"privilegesRequired": "A String",
"scope": "A String",
"userInteraction": "A String",
},
"cvssV3": { # Common Vulnerability Scoring System version 3. For details, see https://www.first.org/cvss/specification-document # The full description of the CVSSv3 for this vulnerability.
"attackComplexity": "A String",
"attackVector": "A String", # Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
"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.
"details": [ # Details of all known distros and packages affected by this vulnerability.
{ # A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
"affectedCpeUri": "A String", # Required. The [CPE URI](https://cpe.mitre.org/specification/) this vulnerability affects.
"affectedPackage": "A String", # Required. The package this vulnerability affects.
"affectedVersionEnd": { # Version contains structured information about the version of a package. # The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"affectedVersionStart": { # Version contains structured information about the version of a package. # The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: [1.0.0-1.1.0], [2.4.6-2.4.8] and [4.5.6-4.6.8]) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"description": "A String", # A vendor-specific description of this vulnerability.
"fixedCpeUri": "A String", # The distro recommended [CPE URI](https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri.
"fixedPackage": "A String", # The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package.
"fixedVersion": { # Version contains structured information about the version of a package. # The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"fullName": "A String", # Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
"inclusive": True or False, # Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
"name": "A String", # Required only when version kind is NORMAL. The main part of the version name.
"revision": "A String", # The iteration of the package build from the above version.
},
"isObsolete": True or False, # Whether this detail is obsolete. Occurrences are expected not to point to obsolete details.
"packageType": "A String", # The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
"severityName": "A String", # The distro assigned severity of 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", # The note provider assigned severity of this 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](https://cpe.mitre.org/specification/) this vulnerability affects.
"description": "A String", # The description of this 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 KBs presence is considered a fix.
{
"name": "A String", # The KB name (generally of the form KB[0-9]+ (e.g., 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 this vulnerability.
},
],
},
"vulnerabilityAssessment": { # A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. # A note describing a vulnerability assessment.
"assessment": { # Assessment provides all information that is related to a single vulnerability for this product. # Represents a vulnerability assessment for the product.
"cve": "A String", # Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
"impacts": [ # Contains information about the impact of this vulnerability, this will change with time.
"A String",
],
"justification": { # Justification provides the justification when the state of the assessment if NOT_AFFECTED. # Justification provides the justification when the state of the assessment if NOT_AFFECTED.
"details": "A String", # Additional details on why this justification was chosen.
"justificationType": "A String", # The justification type for this vulnerability.
},
"longDescription": "A String", # A detailed description of this Vex.
"relatedUris": [ # Holds a list of references associated with this vulnerability item and assessment. These uris have additional information about the vulnerability and the assessment itself. E.g. Link to a document which details how this assessment concluded the state of this vulnerability.
{ # Metadata for any related URL information.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
],
"remediations": [ # Specifies details on how to handle (and presumably, fix) a vulnerability.
{ # Specifies details on how to handle (and presumably, fix) a vulnerability.
"details": "A String", # Contains a comprehensive human-readable discussion of the remediation.
"remediationType": "A String", # The type of remediation that can be applied.
"remediationUri": { # Metadata for any related URL information. # Contains the URL where to obtain the remediation.
"label": "A String", # Label to describe usage of the URL.
"url": "A String", # Specific URL associated with the resource.
},
},
],
"shortDescription": "A String", # A one sentence description of this Vex.
"state": "A String", # Provides the state of this Vulnerability assessment.
"vulnerabilityId": "A String", # The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.
},
"languageCode": "A String", # Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
"longDescription": "A String", # A detailed description of this Vex.
"product": { # Product contains information about a product and how to uniquely identify it. # The product affected by this vex.
"genericUri": "A String", # Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
"id": "A String", # Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document.
"name": "A String", # Name of the product.
},
"publisher": { # Publisher contains information about the publisher of this Note. # Publisher details of this Note.
"issuingAuthority": "A String", # Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
"name": "A String", # Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
"publisherNamespace": "A String", # The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io
},
"shortDescription": "A String", # A one sentence description of this Vex.
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
}</pre>
</div>
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>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.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}</pre>
</div>
</body></html>
|