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
|
package main
import (
"bytes"
"context"
"crypto/x509"
"database/sql"
"errors"
"fmt"
"io"
"net"
"net/http"
"net/url"
"os"
"os/exec"
"os/user"
"path/filepath"
"slices"
"strings"
"sync"
"time"
dqliteClient "github.com/cowsql/go-cowsql/client"
"github.com/cowsql/go-cowsql/driver"
"github.com/gorilla/mux"
liblxc "gopkg.in/lxc/go-lxc.v2"
"golang.org/x/sys/unix"
internalIO "github.com/lxc/incus/v6/internal/io"
"github.com/lxc/incus/v6/internal/linux"
"github.com/lxc/incus/v6/internal/rsync"
"github.com/lxc/incus/v6/internal/server/apparmor"
"github.com/lxc/incus/v6/internal/server/auth"
"github.com/lxc/incus/v6/internal/server/auth/oidc"
"github.com/lxc/incus/v6/internal/server/bgp"
"github.com/lxc/incus/v6/internal/server/certificate"
"github.com/lxc/incus/v6/internal/server/cluster"
clusterConfig "github.com/lxc/incus/v6/internal/server/cluster/config"
"github.com/lxc/incus/v6/internal/server/daemon"
"github.com/lxc/incus/v6/internal/server/db"
dbCluster "github.com/lxc/incus/v6/internal/server/db/cluster"
"github.com/lxc/incus/v6/internal/server/db/query"
"github.com/lxc/incus/v6/internal/server/db/warningtype"
"github.com/lxc/incus/v6/internal/server/dns"
"github.com/lxc/incus/v6/internal/server/endpoints"
"github.com/lxc/incus/v6/internal/server/events"
"github.com/lxc/incus/v6/internal/server/firewall"
"github.com/lxc/incus/v6/internal/server/fsmonitor"
"github.com/lxc/incus/v6/internal/server/instance"
instanceDrivers "github.com/lxc/incus/v6/internal/server/instance/drivers"
"github.com/lxc/incus/v6/internal/server/instance/instancetype"
"github.com/lxc/incus/v6/internal/server/logging"
"github.com/lxc/incus/v6/internal/server/network/ovn"
"github.com/lxc/incus/v6/internal/server/network/ovs"
networkZone "github.com/lxc/incus/v6/internal/server/network/zone"
"github.com/lxc/incus/v6/internal/server/node"
"github.com/lxc/incus/v6/internal/server/project"
"github.com/lxc/incus/v6/internal/server/request"
"github.com/lxc/incus/v6/internal/server/response"
scriptletLoad "github.com/lxc/incus/v6/internal/server/scriptlet/load"
"github.com/lxc/incus/v6/internal/server/seccomp"
"github.com/lxc/incus/v6/internal/server/state"
storagePools "github.com/lxc/incus/v6/internal/server/storage"
storageDrivers "github.com/lxc/incus/v6/internal/server/storage/drivers"
"github.com/lxc/incus/v6/internal/server/storage/s3/miniod"
"github.com/lxc/incus/v6/internal/server/sys"
"github.com/lxc/incus/v6/internal/server/syslog"
"github.com/lxc/incus/v6/internal/server/task"
"github.com/lxc/incus/v6/internal/server/ucred"
localUtil "github.com/lxc/incus/v6/internal/server/util"
"github.com/lxc/incus/v6/internal/server/warnings"
internalUtil "github.com/lxc/incus/v6/internal/util"
"github.com/lxc/incus/v6/internal/version"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/archive"
"github.com/lxc/incus/v6/shared/cancel"
"github.com/lxc/incus/v6/shared/idmap"
"github.com/lxc/incus/v6/shared/logger"
"github.com/lxc/incus/v6/shared/proxy"
"github.com/lxc/incus/v6/shared/revert"
localtls "github.com/lxc/incus/v6/shared/tls"
"github.com/lxc/incus/v6/shared/util"
)
// A Daemon can respond to requests from a shared client.
type Daemon struct {
clientCerts *certificate.Cache
os *sys.OS
db *db.DB
firewall firewall.Firewall
bgp *bgp.Server
dns *dns.Server
// Event servers
devIncusEvents *events.DevIncusServer
events *events.Server
internalListener *events.InternalListener
// Tasks registry for long-running background tasks
// Keep clustering tasks separate as they cause a lot of CPU wakeups
tasks task.Group
clusterTasks task.Group
// Indexes of tasks that need to be reset when their execution interval changes
taskPruneImages *task.Task
taskClusterHeartbeat *task.Task
// Stores startup time of daemon
startTime time.Time
// Whether daemon was started by systemd socket activation.
systemdSocketActivated bool
config *DaemonConfig
endpoints *endpoints.Endpoints
gateway *cluster.Gateway
seccomp *seccomp.Server
proxy func(req *http.Request) (*url.URL, error)
oidcVerifier *oidc.Verifier
// Stores last heartbeat node information to detect node changes.
lastNodeList *cluster.APIHeartbeat
// Serialize changes to cluster membership (joins, leaves, role
// changes).
clusterMembershipMutex sync.RWMutex
serverCert func() *localtls.CertInfo
serverCertInt *localtls.CertInfo // Do not use this directly, use servertCert func.
// Status control.
setupChan chan struct{} // Closed when basic Daemon setup is completed
waitReady *cancel.Canceller // Cancelled when fully ready
shutdownCtx context.Context // Cancelled when shutdown starts.
shutdownCancel context.CancelFunc // Cancels the shutdownCtx to indicate shutdown starting.
shutdownDoneCh chan error // Receives the result of the d.Stop() function and tells the daemon to end.
// Device monitor for watching filesystem events
devmonitor fsmonitor.FSMonitor
// Keep track of skews.
timeSkew bool
// Configuration.
globalConfig *clusterConfig.Config
localConfig *node.Config
globalConfigMu sync.Mutex
// Cluster.
serverName string
serverClustered bool
loggingController *logging.Controller
// Authorization.
authorizer auth.Authorizer
// Syslog listener cancel function.
syslogSocketCancel context.CancelFunc
// OVN clients.
ovnnb *ovn.NB
ovnsb *ovn.SB
ovnMu sync.Mutex
// OVS client.
ovs *ovs.VSwitch
ovsMu sync.Mutex
// API info.
apiExtensions int
}
// DaemonConfig holds configuration values for Daemon.
type DaemonConfig struct {
Group string // Group name the local unix socket should be chown'ed to
Trace []string // List of sub-systems to trace
RaftLatency float64 // Coarse grain measure of the cluster latency
DqliteSetupTimeout time.Duration // How long to wait for the cluster database to be up
}
// newDaemon returns a new Daemon object with the given configuration.
func newDaemon(config *DaemonConfig, os *sys.OS) *Daemon {
incusEvents := events.NewServer(daemon.Debug, daemon.Verbose, cluster.EventHubPush)
devIncusEvents := events.NewDevIncusServer(daemon.Debug, daemon.Verbose)
shutdownCtx, shutdownCancel := context.WithCancel(context.Background())
d := &Daemon{
clientCerts: &certificate.Cache{},
config: config,
devIncusEvents: devIncusEvents,
events: incusEvents,
db: &db.DB{},
os: os,
setupChan: make(chan struct{}),
waitReady: cancel.New(context.Background()),
shutdownCtx: shutdownCtx,
shutdownCancel: shutdownCancel,
shutdownDoneCh: make(chan error),
apiExtensions: len(version.APIExtensions),
}
d.serverCert = func() *localtls.CertInfo { return d.serverCertInt }
return d
}
// defaultDaemonConfig returns a DaemonConfig object with default values.
func defaultDaemonConfig() *DaemonConfig {
return &DaemonConfig{
RaftLatency: 3.0,
DqliteSetupTimeout: 36 * time.Hour, // Account for snap refresh lag
}
}
// defaultDaemon returns a new, un-initialized Daemon object with default values.
func defaultDaemon() *Daemon {
config := defaultDaemonConfig()
os := sys.DefaultOS()
return newDaemon(config, os)
}
// APIEndpoint represents a URL in our API.
type APIEndpoint struct {
Name string // Name for this endpoint.
Path string // Path pattern for this endpoint.
Aliases []APIEndpointAlias // Any aliases for this endpoint.
Get APIEndpointAction
Head APIEndpointAction
Put APIEndpointAction
Post APIEndpointAction
Delete APIEndpointAction
Patch APIEndpointAction
}
// APIEndpointAlias represents an alias URL of and APIEndpoint in our API.
type APIEndpointAlias struct {
Name string // Name for this alias.
Path string // Path pattern for this alias.
}
// APIEndpointAction represents an action on an API endpoint.
type APIEndpointAction struct {
Handler func(d *Daemon, r *http.Request) response.Response
AccessHandler func(d *Daemon, r *http.Request) response.Response
AllowUntrusted bool
}
// allowAuthenticated is an AccessHandler which allows only authenticated requests. This should be used in conjunction
// with further access control within the handler (e.g. to filter resources the user is able to view/edit).
func allowAuthenticated(d *Daemon, r *http.Request) response.Response {
err := d.checkTrustedClient(r)
if err != nil {
return response.SmartError(err)
}
return response.EmptySyncResponse
}
// allowPermission is a wrapper to check access against a given object, an object being an image, instance, network, etc.
// Mux vars should be passed in so that the object we are checking can be created. For example, a certificate object requires
// a fingerprint, the mux var for certificate fingerprints is "fingerprint", so that string should be passed in.
// Mux vars should always be passed in with the same order they appear in the API route.
func allowPermission(objectType auth.ObjectType, entitlement auth.Entitlement, muxVars ...string) func(d *Daemon, r *http.Request) response.Response {
return func(d *Daemon, r *http.Request) response.Response {
// Expansion function to deal with partial fingerprints.
expandFingerprint := func(projectName string, fingerprint string) string {
if objectType == auth.ObjectTypeImage {
var imgInfo *api.Image
err := d.db.Cluster.Transaction(r.Context(), func(ctx context.Context, tx *db.ClusterTx) error {
var err error
_, imgInfo, err = tx.GetImage(ctx, fingerprint, dbCluster.ImageFilter{Project: &projectName})
return err
})
if err != nil {
return fingerprint
}
fingerprint = imgInfo.Fingerprint
} else if objectType == auth.ObjectTypeCertificate {
err := d.db.Cluster.Transaction(r.Context(), func(ctx context.Context, tx *db.ClusterTx) error {
dbCertInfo, err := dbCluster.GetCertificateByFingerprintPrefix(ctx, tx.Tx(), fingerprint)
if err != nil {
return err
}
fingerprint = dbCertInfo.Fingerprint
return nil
})
if err != nil {
return fingerprint
}
}
// Fallback to no expansion.
return fingerprint
}
// Expansion function to deal with project inheritance.
expandProject := func(projectName string) string {
// Object types that aren't part of projects.
if slices.Contains([]auth.ObjectType{auth.ObjectTypeUser, auth.ObjectTypeServer, auth.ObjectTypeCertificate, auth.ObjectTypeStoragePool, auth.ObjectTypeNetworkIntegration}, objectType) {
return projectName
}
// Load the project.
var p *api.Project
err := d.db.Cluster.Transaction(r.Context(), func(ctx context.Context, tx *db.ClusterTx) error {
dbProject, err := dbCluster.GetProject(ctx, tx.Tx(), projectName)
if err != nil {
return err
}
p, err = dbProject.ToAPI(ctx, tx.Tx())
if err != nil {
return err
}
return nil
})
if err != nil {
return projectName
}
if objectType == auth.ObjectTypeProfile {
projectName = project.ProfileProjectFromRecord(p)
} else if objectType == auth.ObjectTypeStorageBucket {
projectName = project.StorageBucketProjectFromRecord(p)
} else if objectType == auth.ObjectTypeStorageVolume {
dbVolType, err := storagePools.VolumeTypeNameToDBType(muxVars[1])
if err != nil {
return projectName
}
projectName = project.StorageVolumeProjectFromRecord(p, dbVolType)
} else if objectType == auth.ObjectTypeNetworkZone {
projectName = project.NetworkZoneProjectFromRecord(p)
} else if slices.Contains([]auth.ObjectType{auth.ObjectTypeImage, auth.ObjectTypeImageAlias}, objectType) {
projectName = project.ImageProjectFromRecord(p)
} else if slices.Contains([]auth.ObjectType{auth.ObjectTypeNetwork, auth.ObjectTypeNetworkACL}, objectType) {
projectName = project.NetworkProjectFromRecord(p)
}
return projectName
}
// Expansion function for volume location.
expandVolumeLocation := func(projectName string, poolName string, volumeTypeName string, volumeName string) string {
// The location field is only relevant in clusters.
if !d.serverClustered {
return ""
}
var err error
var nodes []db.NodeInfo
var poolID int64
// Convert the volume type name to our internal integer representation.
volumeType, err := storagePools.VolumeTypeNameToDBType(volumeTypeName)
if err != nil {
return ""
}
// Get the server list for the volume.
err = d.db.Cluster.Transaction(r.Context(), func(ctx context.Context, tx *db.ClusterTx) error {
poolID, err = tx.GetStoragePoolID(ctx, poolName)
if err != nil {
return err
}
nodes, err = tx.GetStorageVolumeNodes(ctx, poolID, projectName, volumeName, volumeType)
if err != nil {
return err
}
return nil
})
if err != nil {
return ""
}
if len(nodes) != 1 {
return ""
}
return nodes[0].Name
}
objectName, err := auth.ObjectFromRequest(r, objectType, expandProject, expandFingerprint, expandVolumeLocation, muxVars...)
if err != nil {
return response.InternalError(fmt.Errorf("Failed to create authentication object: %w", err))
}
s := d.State()
// Validate whether the user has the needed permission
err = s.Authorizer.CheckPermission(r.Context(), r, objectName, entitlement)
if err != nil {
return response.SmartError(err)
}
return response.EmptySyncResponse
}
}
// Convenience function around Authenticate.
func (d *Daemon) checkTrustedClient(r *http.Request) error {
trusted, _, _, err := d.Authenticate(nil, r)
if !trusted || err != nil {
if err != nil {
return err
}
return errors.New("Not authorized")
}
return nil
}
// getTrustedCertificates returns trusted certificates key on DB type and fingerprint.
//
// When in PKI mode, this also filters out any non-server certificate which isn't issued by the PKI.
func (d *Daemon) getTrustedCertificates() (map[certificate.Type]map[string]x509.Certificate, error) {
certs := d.clientCerts.GetCertificates()
// If not in PKI mode, return all certificates.
if !util.PathExists(internalUtil.VarPath("server.ca")) {
return certs, nil
}
// If in PKI mode, filter certificates that aren't trusted by the CA.
ca, err := localtls.ReadCert(internalUtil.VarPath("server.ca"))
if err != nil {
return nil, err
}
certPool := x509.NewCertPool()
certPool.AddCert(ca)
for certType, certEntries := range certs {
if certType == certificate.TypeServer {
continue
}
for name, entry := range certEntries {
_, err := entry.Verify(x509.VerifyOptions{
Roots: certPool,
KeyUsages: []x509.ExtKeyUsage{x509.ExtKeyUsageClientAuth},
})
if err != nil {
// Skip certificates that aren't signed by the PKI.
delete(certs[certType], name)
}
}
}
return certs, nil
}
// Authenticate validates an incoming http Request
// It will check over what protocol it came, what type of request it is and
// will validate the TLS certificate.
//
// This does not perform authorization, only validates authentication.
// Returns whether trusted or not, the username (or certificate fingerprint) of the trusted client, and the type of
// client that has been authenticated (cluster, unix, or tls).
func (d *Daemon) Authenticate(w http.ResponseWriter, r *http.Request) (bool, string, string, error) {
trustedCerts, err := d.getTrustedCertificates()
if err != nil {
return false, "", "", err
}
// Allow internal cluster traffic by checking against the trusted certfificates.
if r.TLS != nil {
for _, i := range r.TLS.PeerCertificates {
trusted, fingerprint := localUtil.CheckTrustState(*i, trustedCerts[certificate.TypeServer], d.endpoints.NetworkCert(), false)
if trusted {
return true, fingerprint, "cluster", nil
}
}
}
// Local unix socket queries.
if r.RemoteAddr == "@" && r.TLS == nil {
if w != nil {
cred, err := ucred.GetCredFromContext(r.Context())
if err != nil {
return false, "", "", err
}
u, err := user.LookupId(fmt.Sprintf("%d", cred.Uid))
if err != nil {
return true, fmt.Sprintf("uid=%d", cred.Uid), "unix", nil
}
return true, u.Username, "unix", nil
}
return true, "", "unix", nil
}
// DevIncus unix socket credentials on main API.
if r.RemoteAddr == "@dev_incus" {
return false, "", "", errors.New("Main API query can't come from /dev/incus socket")
}
// Cluster notification with wrong certificate.
if isClusterNotification(r) {
return false, "", "", errors.New("Cluster notification isn't using trusted server certificate")
}
// Cluster internal client with wrong certificate.
if isClusterInternal(r) {
return false, "", "", errors.New("Cluster internal client isn't using trusted server certificate")
}
// Bad query, no TLS found.
if r.TLS == nil {
return false, "", "", errors.New("Bad/missing TLS on network query")
}
// Load the certificates.
trustCACertificates := d.globalConfig.TrustCACertificates()
// Check for JWT token signed by a TLS certificate.
jwtOk, _, cert := localUtil.CheckJwtToken(r, trustedCerts[certificate.TypeClient])
if jwtOk {
trusted, username := localUtil.CheckTrustState(*cert, trustedCerts[certificate.TypeClient], d.endpoints.NetworkCert(), trustCACertificates)
if trusted {
return true, username, api.AuthenticationMethodTLS, nil
}
}
// Check for JWT token signed by an OpenID Connect provider.
if d.oidcVerifier != nil && d.oidcVerifier.IsRequest(r) {
userName, err := d.oidcVerifier.Auth(d.shutdownCtx, w, r)
if err != nil {
return false, "", "", err
}
return true, userName, api.AuthenticationMethodOIDC, nil
}
// Validate metrics TLS certificates.
if r.URL.Path == "/1.0/metrics" {
for _, i := range r.TLS.PeerCertificates {
trusted, username := localUtil.CheckTrustState(*i, trustedCerts[certificate.TypeMetrics], d.endpoints.NetworkCert(), trustCACertificates)
if trusted {
return true, username, api.AuthenticationMethodTLS, nil
}
}
}
// Validate regular TLS certificates.
for _, i := range r.TLS.PeerCertificates {
trusted, username := localUtil.CheckTrustState(*i, trustedCerts[certificate.TypeClient], d.endpoints.NetworkCert(), trustCACertificates)
if trusted {
return true, username, api.AuthenticationMethodTLS, nil
}
}
// Reject unauthorized.
return false, "", "", nil
}
// State creates a new State instance linked to our internal db and os.
func (d *Daemon) State() *state.State {
// If the daemon is shutting down, the context will be cancelled.
// This information will be available throughout the code, and can be used to prevent new
// operations from starting during shutdown.
// Build a list of instance types.
drivers := instanceDrivers.DriverStatuses()
instanceTypes := make(map[instancetype.Type]error, len(drivers))
for driverType, driver := range drivers {
instanceTypes[driverType] = driver.Info.Error
}
d.globalConfigMu.Lock()
globalConfig := d.globalConfig
localConfig := d.localConfig
d.globalConfigMu.Unlock()
return &state.State{
Authorizer: d.authorizer,
BGP: d.bgp,
Cluster: d.gateway,
DB: d.db,
DevIncusEvents: d.devIncusEvents,
DevMonitor: d.devmonitor,
DNS: d.dns,
Endpoints: d.endpoints,
Events: d.events,
Firewall: d.firewall,
GlobalConfig: globalConfig,
InstanceTypes: instanceTypes,
LocalConfig: localConfig,
OS: d.os,
OVN: d.getOVN,
OVS: d.getOVS,
Proxy: d.proxy,
ServerCert: d.serverCert,
ServerClustered: d.serverClustered,
ServerName: d.serverName,
ShutdownCtx: d.shutdownCtx,
StartTime: d.startTime,
UpdateCertificateCache: func() { updateCertificateCache(d) },
}
}
func (d *Daemon) createCmd(restAPI *mux.Router, version string, c APIEndpoint) {
var uri string
if c.Path == "" {
uri = fmt.Sprintf("/%s", version)
} else if version != "" {
uri = fmt.Sprintf("/%s/%s", version, c.Path)
} else {
uri = fmt.Sprintf("/%s", c.Path)
}
route := restAPI.HandleFunc(uri, func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
if !(r.RemoteAddr == "@" && version == "internal") {
// Block public API requests until we're done with basic
// initialization tasks, such setting up the cluster database.
select {
case <-d.setupChan:
default:
response := response.Unavailable(errors.New("Daemon is starting up"))
_ = response.Render(w)
return
}
}
// Authentication
trusted, username, protocol, err := d.Authenticate(w, r)
if err != nil {
var authError *oidc.AuthError
if errors.As(err, &authError) {
// Ensure the OIDC headers are set if needed.
if d.oidcVerifier != nil {
_ = d.oidcVerifier.WriteHeaders(w)
}
_ = response.Unauthorized(err).Render(w)
return
}
}
// Reject internal queries to remote, non-cluster, clients
if version == "internal" && !slices.Contains([]string{"unix", "cluster"}, protocol) {
// Except for the initial cluster accept request (done over trusted TLS)
if !trusted || c.Path != "cluster/accept" || protocol != api.AuthenticationMethodTLS {
logger.Warn("Rejecting remote internal API request", logger.Ctx{"ip": r.RemoteAddr})
_ = response.Forbidden(nil).Render(w)
return
}
}
logCtx := logger.Ctx{"method": r.Method, "url": r.URL.RequestURI(), "ip": r.RemoteAddr, "protocol": protocol}
if protocol == "cluster" {
logCtx["fingerprint"] = username
} else {
logCtx["username"] = username
}
untrustedOk := (r.Method == "GET" && c.Get.AllowUntrusted) || (r.Method == "POST" && c.Post.AllowUntrusted)
if trusted {
logger.Debug("Handling API request", logCtx)
// Add authentication/authorization context data.
ctx := context.WithValue(r.Context(), request.CtxUsername, username)
ctx = context.WithValue(ctx, request.CtxProtocol, protocol)
// Add forwarded requestor data.
if protocol == "cluster" {
// Add authentication/authorization context data.
ctx = context.WithValue(ctx, request.CtxForwardedAddress, r.Header.Get(request.HeaderForwardedAddress))
ctx = context.WithValue(ctx, request.CtxForwardedUsername, r.Header.Get(request.HeaderForwardedUsername))
ctx = context.WithValue(ctx, request.CtxForwardedProtocol, r.Header.Get(request.HeaderForwardedProtocol))
}
r = r.WithContext(ctx)
} else if untrustedOk && r.Header.Get("X-Incus-authenticated") == "" {
logger.Debug(fmt.Sprintf("Allowing untrusted %s", r.Method), logger.Ctx{"url": r.URL.RequestURI(), "ip": r.RemoteAddr})
} else {
if d.oidcVerifier != nil {
_ = d.oidcVerifier.WriteHeaders(w)
}
logger.Warn("Rejecting request from untrusted client", logger.Ctx{"ip": r.RemoteAddr})
_ = response.Forbidden(nil).Render(w)
return
}
// Dump full request JSON when in debug mode
if daemon.Debug && r.Method != "GET" && localUtil.IsJSONRequest(r) {
newBody := &bytes.Buffer{}
captured := &bytes.Buffer{}
multiW := io.MultiWriter(newBody, captured)
_, err := io.Copy(multiW, r.Body)
if err != nil {
_ = response.InternalError(err).Render(w)
return
}
r.Body = internalIO.BytesReadCloser{Buf: newBody}
localUtil.DebugJSON("API Request", captured, logger.AddContext(logCtx))
}
// Actually process the request
var resp response.Response
// Return Unavailable Error (503) if daemon is shutting down.
// There are some exceptions:
// - internal calls, e.g. shutdown
// - events endpoint as this is accessed when running `shutdown`
// - /1.0 endpoint
// - /1.0/operations endpoints
// - GET queries
allowedDuringShutdown := func() bool {
if version == "internal" {
return true
}
if c.Path == "" || c.Path == "events" || c.Path == "operations" || strings.HasPrefix(c.Path, "operations/") {
return true
}
if r.Method == "GET" {
return true
}
return false
}
if errors.Is(d.shutdownCtx.Err(), context.Canceled) && !allowedDuringShutdown() {
_ = response.Unavailable(errors.New("Shutting down")).Render(w)
return
}
handleRequest := func(action APIEndpointAction) response.Response {
if action.Handler == nil {
return response.NotImplemented(nil)
}
// All APIEndpointActions should have an access handler or should allow untrusted requests.
if action.AccessHandler == nil && !action.AllowUntrusted {
return response.InternalError(fmt.Errorf("Access handler not defined for %s %s", r.Method, r.URL.RequestURI()))
}
// If the request is not trusted, only call the handler if the action allows it.
if !trusted && !action.AllowUntrusted {
return response.Forbidden(errors.New("You must be authenticated"))
}
// Protect against CSRF when using UI with browser that supports Fetch metadata.
// Deny Sec-Fetch-Site when set to cross-origin or same-site.
if slices.Contains([]string{"cross-site", "same-site"}, r.Header.Get("Sec-Fetch-Site")) {
return response.ErrorResponse(http.StatusForbidden, "Forbidden Sec-Fetch-Site header value")
}
// Call the access handler if there is one.
if action.AccessHandler != nil {
resp := action.AccessHandler(d, r)
if resp != response.EmptySyncResponse {
return resp
}
}
return action.Handler(d, r)
}
switch r.Method {
case "GET":
resp = handleRequest(c.Get)
case "HEAD":
resp = handleRequest(c.Head)
case "PUT":
resp = handleRequest(c.Put)
case "POST":
resp = handleRequest(c.Post)
case "DELETE":
resp = handleRequest(c.Delete)
case "PATCH":
resp = handleRequest(c.Patch)
default:
resp = response.NotFound(fmt.Errorf("Method %q not found", r.Method))
}
// If sending out Forbidden, make sure we have OIDC headers.
if resp.Code() == http.StatusForbidden && d.oidcVerifier != nil {
_ = d.oidcVerifier.WriteHeaders(w)
}
// Handle errors
err = resp.Render(w)
if err != nil {
writeErr := response.SmartError(err).Render(w)
if writeErr != nil {
logger.Error("Failed writing error for HTTP response", logger.Ctx{"url": uri, "err": err, "writeErr": writeErr})
}
}
})
// If the endpoint has a canonical name then record it so it can be used to build URLS
// and accessed in the context of the request by the handler function.
if c.Name != "" {
route.Name(c.Name)
}
}
// have we setup shared mounts?
var sharedMountsLock sync.Mutex
// setupSharedMounts will mount any shared mounts needed, and set daemon.SharedMountsSetup to true.
func setupSharedMounts() error {
// Check if we already went through this
if daemon.SharedMountsSetup {
return nil
}
// Get a lock to prevent races
sharedMountsLock.Lock()
defer sharedMountsLock.Unlock()
// Check if already setup
path := internalUtil.VarPath("shmounts")
if linux.IsMountPoint(path) {
daemon.SharedMountsSetup = true
return nil
}
// Mount a new tmpfs
err := unix.Mount("tmpfs", path, "tmpfs", 0, "size=100k,mode=0711")
if err != nil {
return err
}
// Mark as MS_SHARED and MS_REC
var flags uintptr = unix.MS_SHARED | unix.MS_REC
err = unix.Mount(path, path, "none", flags, "")
if err != nil {
return err
}
daemon.SharedMountsSetup = true
return nil
}
// Init starts daemon process.
func (d *Daemon) Init() error {
d.startTime = time.Now()
err := d.init()
// If an error occurred synchronously while starting up, let's try to
// cleanup any state we produced so far. Errors happening here will be
// ignored.
if err != nil {
logger.Error("Failed to start the daemon", logger.Ctx{"err": err})
_ = d.Stop(context.Background(), unix.SIGINT)
return err
}
return nil
}
func (d *Daemon) init() error {
var err error
var dbWarnings []dbCluster.Warning
// Set default authorizer.
d.authorizer, err = auth.LoadAuthorizer(d.shutdownCtx, auth.DriverTLS, logger.Log, d.clientCerts)
if err != nil {
return err
}
// Setup logger
events.LoggingServer = d.events
// Setup internal event listener
d.internalListener = events.NewInternalListener(d.shutdownCtx, d.events)
// Lets check if there's an existing daemon running
err = endpoints.CheckAlreadyRunning(d.os.GetUnixSocket())
if err != nil {
return err
}
/* Set the LVM environment */
err = os.Setenv("LVM_SUPPRESS_FD_WARNINGS", "1")
if err != nil {
return err
}
/* Print welcome message */
mode := "normal"
if d.os.MockMode {
mode = "mock"
}
logger.Info("Starting up", logger.Ctx{"version": version.Version, "mode": mode, "path": internalUtil.VarPath("")})
/* List of sub-systems to trace */
trace := d.config.Trace
/* Initialize the operating system facade */
dbWarnings, err = d.os.Init()
if err != nil {
return err
}
// Initialize apparmor.
if d.os.AppArmorAvailable {
err := apparmor.Init()
if err != nil {
return fmt.Errorf("Failed to initialize apparmor: %v", err)
}
}
// Setup AppArmor wrapper.
archive.RunWrapper = func(cmd *exec.Cmd, output string, allowedCmds []string) (func(), error) {
return apparmor.ArchiveWrapper(d.os, cmd, output, allowedCmds)
}
rsync.RunWrapper = func(cmd *exec.Cmd, source string, destination string) (func(), error) {
return apparmor.RsyncWrapper(d.os, cmd, source, destination)
}
// Bump some kernel limits to avoid issues
for _, limit := range []int{unix.RLIMIT_NOFILE} {
rLimit := unix.Rlimit{}
err := unix.Getrlimit(limit, &rLimit)
if err != nil {
return err
}
rLimit.Cur = rLimit.Max
err = unix.Setrlimit(limit, &rLimit)
if err != nil {
return err
}
}
// Detect LXC features
d.os.LXCFeatures = map[string]bool{}
lxcExtensions := []string{
"mount_injection_file",
"seccomp_notify",
"network_ipvlan",
"network_l2proxy",
"network_gateway_device_route",
"network_phys_macvlan_mtu",
"network_veth_router",
"cgroup2",
"pidfd",
"seccomp_allow_deny_syntax",
"devpts_fd",
"seccomp_proxy_send_notify_fd",
"idmapped_mounts_v2",
"core_scheduling",
}
for _, extension := range lxcExtensions {
d.os.LXCFeatures[extension] = liblxc.HasAPIExtension(extension)
}
// Look for kernel features
logger.Infof("Kernel features:")
d.os.CloseRange = canUseCloseRange()
if d.os.CloseRange {
logger.Info(" - closing multiple file descriptors efficiently: yes")
} else {
logger.Info(" - closing multiple file descriptors efficiently: no")
}
d.os.NetnsGetifaddrs = canUseNetnsGetifaddrs()
if d.os.NetnsGetifaddrs {
logger.Info(" - netnsid-based network retrieval: yes")
} else {
logger.Info(" - netnsid-based network retrieval: no")
}
if canUsePidFds() && d.os.LXCFeatures["pidfd"] {
d.os.PidFds = true
d.os.PidFdsThread = canUseThreadPidFds()
}
if d.os.PidFds {
logger.Info(" - pidfds: yes")
} else {
logger.Info(" - pidfds: no")
}
if d.os.PidFdsThread {
logger.Info(" - pidfds for threads: yes")
} else {
logger.Info(" - pidfds for threads: no")
}
if canUseCoreScheduling() {
d.os.CoreScheduling = true
logger.Info(" - core scheduling: yes")
if d.os.LXCFeatures["core_scheduling"] {
d.os.ContainerCoreScheduling = true
}
} else {
logger.Info(" - core scheduling: no")
}
d.os.UeventInjection = canUseUeventInjection()
if d.os.UeventInjection {
logger.Info(" - uevent injection: yes")
} else {
logger.Info(" - uevent injection: no")
}
d.os.SeccompListener = canUseSeccompListener()
if d.os.SeccompListener {
logger.Info(" - seccomp listener: yes")
} else {
logger.Info(" - seccomp listener: no")
}
d.os.SeccompListenerContinue = canUseSeccompListenerContinue()
if d.os.SeccompListenerContinue {
logger.Info(" - seccomp listener continue syscalls: yes")
} else {
logger.Info(" - seccomp listener continue syscalls: no")
}
if canUseSeccompListenerAddfd() && d.os.LXCFeatures["seccomp_proxy_send_notify_fd"] {
d.os.SeccompListenerAddfd = true
logger.Info(" - seccomp listener add file descriptors: yes")
} else {
logger.Info(" - seccomp listener add file descriptors: no")
}
d.os.PidFdSetns = canUsePidFdSetns()
if d.os.PidFdSetns {
logger.Info(" - attach to namespaces via pidfds: yes")
} else {
logger.Info(" - attach to namespaces via pidfds: no")
}
if d.os.LXCFeatures["devpts_fd"] && canUseNativeTerminals() {
d.os.NativeTerminals = true
logger.Info(" - safe native terminal allocation: yes")
} else {
logger.Info(" - safe native terminal allocation: no")
}
d.os.UnprivBinfmt = canUseBinfmt()
if d.os.UnprivBinfmt {
logger.Info(" - unprivileged binfmt_misc: yes")
} else {
logger.Info(" - unprivileged binfmt_misc: no")
}
/*
* During daemon startup we're the only thread that touches VFS3Fscaps
* so we don't need to bother with atomic.StoreInt32() when touching
* VFS3Fscaps.
*/
d.os.VFS3Fscaps = idmap.SupportsVFS3FSCaps("")
if d.os.VFS3Fscaps {
idmap.VFS3FSCaps = idmap.VFS3FSCapsSupported
logger.Infof(" - unprivileged file capabilities: yes")
} else {
idmap.VFS3FSCaps = idmap.VFS3FSCapsUnsupported
logger.Infof(" - unprivileged file capabilities: no")
}
dbWarnings = append(dbWarnings, d.os.CGInfo.Warnings()...)
logger.Infof(" - cgroup layout: %s", d.os.CGInfo.Mode())
for _, w := range dbWarnings {
logger.Warnf(" - %s, %s", warningtype.TypeNames[warningtype.Type(w.TypeCode)], w.LastMessage)
}
// Detect idmapped mounts support.
if util.IsTrue(os.Getenv("INCUS_IDMAPPED_MOUNTS_DISABLE")) {
logger.Info(" - idmapped mounts kernel support: disabled")
} else if kernelSupportsIdmappedMounts() {
d.os.IdmappedMounts = true
logger.Info(" - idmapped mounts kernel support: yes")
} else {
logger.Info(" - idmapped mounts kernel support: no")
}
// Detect and cached available instance types from operational drivers.
drivers := instanceDrivers.DriverStatuses()
for _, driver := range drivers {
if driver.Warning != nil {
dbWarnings = append(dbWarnings, *driver.Warning)
}
}
// Validate the devices storage.
testDev := internalUtil.VarPath("devices", ".test")
testDevNum := int(unix.Mkdev(0, 0))
_ = os.Remove(testDev)
err = unix.Mknod(testDev, 0o600|unix.S_IFCHR, testDevNum)
if err == nil {
fd, err := os.Open(testDev)
if err != nil && os.IsPermission(err) {
logger.Warn("Unable to access device nodes, likely running on a nodev mount")
d.os.Nodev = true
}
_ = fd.Close()
_ = os.Remove(testDev)
}
/* Initialize the database */
err = initializeDbObject(d)
if err != nil {
return err
}
/* Setup network endpoint certificate */
networkCert, err := internalUtil.LoadCert(d.os.VarDir)
if err != nil {
return err
}
/* Setup server certificate */
serverCert, err := internalUtil.LoadServerCert(d.os.VarDir)
if err != nil {
return err
}
// Load cached local trusted certificates before starting listener and cluster database.
err = updateCertificateCacheFromLocal(d)
if err != nil {
return err
}
d.serverClustered, err = cluster.Enabled(d.db.Node)
if err != nil {
return fmt.Errorf("Failed checking if clustered: %w", err)
}
// Detect if clustered, but not yet upgraded to per-server client certificates.
certificates := d.clientCerts.GetCertificates()
if d.serverClustered && len(certificates[certificate.TypeServer]) < 1 {
// If the cluster has not yet upgraded to per-server client certificates (by running patch
// patchClusteringServerCertTrust) then temporarily use the network (cluster) certificate as client
// certificate, and cause us to trust it for use as client certificate from the other members.
networkCertFingerPrint := networkCert.Fingerprint()
logger.Warn("No local trusted server certificates found, falling back to trusting network certificate", logger.Ctx{"fingerprint": networkCertFingerPrint})
logger.Info("Set client certificate to network certificate", logger.Ctx{"fingerprint": networkCertFingerPrint})
d.serverCertInt = networkCert
} else {
// If standalone or the local trusted certificates table is populated with server certificates then
// use our local server certificate as client certificate for intra-cluster communication.
logger.Info("Set client certificate to server certificate", logger.Ctx{"fingerprint": serverCert.Fingerprint()})
d.serverCertInt = serverCert
}
/* Setup dqlite */
clusterLogLevel := "ERROR"
if slices.Contains(trace, "dqlite") {
clusterLogLevel = "TRACE"
}
d.gateway, err = cluster.NewGateway(
d.shutdownCtx,
d.db.Node,
networkCert,
d.State,
cluster.Latency(d.config.RaftLatency),
cluster.LogLevel(clusterLogLevel))
if err != nil {
return err
}
d.gateway.HeartbeatNodeHook = d.nodeRefreshTask
/* Setup some mounts (nice to have) */
if !d.os.MockMode {
// Attempt to mount the shmounts tmpfs
err := setupSharedMounts()
if err != nil {
logger.Warn("Failed setting up shared mounts", logger.Ctx{"err": err})
}
// Attempt to Mount the devIncus tmpfs
devIncus := filepath.Join(d.os.VarDir, "guestapi")
if !linux.IsMountPoint(devIncus) {
err = unix.Mount("tmpfs", devIncus, "tmpfs", 0, "size=100k,mode=0755")
if err != nil {
logger.Warn("Failed to mount devIncus", logger.Ctx{"err": err})
}
}
}
logger.Info("Loading daemon configuration")
err = d.db.Node.Transaction(context.TODO(), func(ctx context.Context, tx *db.NodeTx) error {
d.localConfig, err = node.ConfigLoad(ctx, tx)
return err
})
if err != nil {
return err
}
localHTTPAddress := d.localConfig.HTTPSAddress()
localClusterAddress := d.localConfig.ClusterAddress()
debugAddress := d.localConfig.DebugAddress()
if os.Getenv("LISTEN_PID") != "" {
d.systemdSocketActivated = true
}
/* Setup the web server */
config := &endpoints.Config{
Dir: d.os.VarDir,
UnixSocket: d.os.GetUnixSocket(),
Cert: networkCert,
RestServer: restServer(d),
DevIncusServer: devIncusServer(d),
LocalUnixSocketGroup: d.config.Group,
LocalUnixSocketLabel: "system_u:object_r:container_runtime_t:s0",
NetworkAddress: localHTTPAddress,
ClusterAddress: localClusterAddress,
DebugAddress: debugAddress,
MetricsServer: metricsServer(d),
StorageBucketsServer: storageBucketsServer(d),
VsockServer: vSockServer(d),
VsockSupport: false,
}
// Enable vsock server support if VM instances supported.
err, found := d.State().InstanceTypes[instancetype.VM]
if found && err == nil {
config.VsockSupport = true
}
d.endpoints, err = endpoints.Up(config)
if err != nil {
return err
}
// Have the db package determine remote storage drivers
db.StorageRemoteDriverNames = storageDrivers.RemoteDriverNames
/* Open the cluster database */
for {
logger.Info("Initializing global database")
dir := filepath.Join(d.os.VarDir, "database")
store := d.gateway.NodeStore()
contextTimeout := 30 * time.Second
if !d.serverClustered {
// FIXME: this is a workaround for #5234. We set a very
// high timeout when we're not clustered, since there's
// actually no networking involved.
contextTimeout = time.Minute
}
options := []driver.Option{
driver.WithDialFunc(d.gateway.DialFunc()),
driver.WithContext(d.gateway.Context()),
driver.WithConnectionTimeout(10 * time.Second),
driver.WithContextTimeout(contextTimeout),
driver.WithLogFunc(cluster.DqliteLog),
}
if slices.Contains(trace, "database") {
options = append(options, driver.WithTracing(dqliteClient.LogDebug))
}
d.db.Cluster, err = db.OpenCluster(context.Background(), "db.bin", store, localClusterAddress, dir, d.config.DqliteSetupTimeout, options...)
if err == nil {
logger.Info("Initialized global database")
break
} else if errors.Is(err, db.ErrSomeNodesAreBehind) {
// If some other nodes have schema or API versions less recent
// than this node, we block until we receive a notification
// from the last node being upgraded that everything should be
// now fine, and then retry
logger.Warn("Wait for other cluster nodes to upgrade their versions, cluster not started yet")
// The only thing we want to still do on this node is
// to run the heartbeat task, in case we are the raft
// leader.
d.gateway.Cluster = d.db.Cluster
taskFunc, taskSchedule := cluster.HeartbeatTask(d.gateway)
hbGroup := task.Group{}
d.taskClusterHeartbeat = hbGroup.Add(taskFunc, taskSchedule)
hbGroup.Start(d.shutdownCtx)
d.gateway.WaitUpgradeNotification()
_ = hbGroup.Stop(time.Second)
d.gateway.Cluster = nil
_ = d.db.Cluster.Close()
continue
}
return fmt.Errorf("Failed to initialize global database: %w", err)
}
d.firewall = firewall.New()
logger.Info("Firewall loaded driver", logger.Ctx{"driver": d.firewall})
err = cluster.NotifyUpgradeCompleted(d.State(), networkCert, d.serverCert())
if err != nil {
// Ignore the error, since it's not fatal for this particular
// node. In most cases it just means that some nodes are
// offline.
logger.Warn("Could not notify all nodes of database upgrade", logger.Ctx{"err": err})
}
d.gateway.Cluster = d.db.Cluster
// Setup the user-agent.
if d.serverClustered {
version.UserAgentFeatures([]string{"cluster"})
}
// Load server name and config before patches run (so they can access them from d.State()).
err = d.db.Cluster.Transaction(d.shutdownCtx, func(ctx context.Context, tx *db.ClusterTx) error {
config, err := clusterConfig.Load(ctx, tx)
if err != nil {
return err
}
// Get the local node (will be used if clustered).
serverName, err := tx.GetLocalNodeName(ctx)
if err != nil {
return err
}
d.globalConfigMu.Lock()
d.serverName = serverName
d.globalConfig = config
d.globalConfigMu.Unlock()
return nil
})
if err != nil {
return err
}
d.events.SetLocalLocation(d.serverName)
// Mount the storage pools.
logger.Infof("Initializing storage pools")
err = storageStartup(d.State())
if err != nil {
return err
}
// Apply all patches that need to be run before daemon storage is initialized.
err = patchesApply(d, patchPreDaemonStorage)
if err != nil {
return err
}
// Mount any daemon storage volumes.
logger.Infof("Initializing daemon storage mounts")
err = daemonStorageMount(d.State())
if err != nil {
return err
}
// Create directories on daemon storage mounts.
err = d.os.InitStorage()
if err != nil {
return err
}
// Apply all patches that need to be run after daemon storage is initialized.
err = patchesApply(d, patchPostDaemonStorage)
if err != nil {
return err
}
// Load server name and config after patches run (in case its been changed).
err = d.db.Cluster.Transaction(d.shutdownCtx, func(ctx context.Context, tx *db.ClusterTx) error {
config, err := clusterConfig.Load(ctx, tx)
if err != nil {
return err
}
// Get the local node (will be used if clustered).
serverName, err := tx.GetLocalNodeName(ctx)
if err != nil {
return err
}
d.globalConfigMu.Lock()
d.serverName = serverName
d.globalConfig = config
d.globalConfigMu.Unlock()
return nil
})
if err != nil {
return err
}
d.events.SetLocalLocation(d.serverName)
// Get daemon configuration.
bgpAddress := d.localConfig.BGPAddress()
bgpRouterID := d.localConfig.BGPRouterID()
bgpASN := int64(0)
dnsAddress := d.localConfig.DNSAddress()
// Get specific config keys.
d.globalConfigMu.Lock()
bgpASN = d.globalConfig.BGPASN()
d.proxy = proxy.FromConfig(d.globalConfig.ProxyHTTPS(), d.globalConfig.ProxyHTTP(), d.globalConfig.ProxyIgnoreHosts())
d.gateway.HeartbeatOfflineThreshold = d.globalConfig.OfflineThreshold()
oidcIssuer, oidcClientID, oidcScope, oidcAudience, oidcClaim := d.globalConfig.OIDCServer()
syslogSocketEnabled := d.localConfig.SyslogSocket()
openfgaAPIURL, openfgaAPIToken, openfgaStoreID := d.globalConfig.OpenFGA()
instancePlacementScriptlet := d.globalConfig.InstancesPlacementScriptlet()
authorizationScriptlet := d.globalConfig.AuthorizationScriptlet()
d.endpoints.NetworkUpdateTrustedProxy(d.globalConfig.HTTPSTrustedProxy())
d.globalConfigMu.Unlock()
d.loggingController = logging.NewLoggingController(d.internalListener)
err = d.loggingController.Setup(d.State())
if err != nil {
return err
}
// Setup syslog listener.
if syslogSocketEnabled {
err = d.setupSyslogSocket(true)
if err != nil {
return err
}
}
// Setup OIDC authentication.
if oidcIssuer != "" && oidcClientID != "" {
d.oidcVerifier, err = oidc.NewVerifier(oidcIssuer, oidcClientID, oidcScope, oidcAudience, oidcClaim)
if err != nil {
return err
}
}
// Setup OpenFGA authorization.
if openfgaAPIURL != "" && openfgaStoreID != "" && openfgaAPIToken != "" {
err = d.setupOpenFGA(openfgaAPIURL, openfgaAPIToken, openfgaStoreID)
if err != nil {
return fmt.Errorf("Failed to configure OpenFGA: %w", err)
}
}
// Setup the authorization scriptlet.
if authorizationScriptlet != "" {
err = d.setupAuthorizationScriptlet(authorizationScriptlet)
if err != nil {
return err
}
}
// Setup BGP listener.
d.bgp = bgp.NewServer()
if bgpAddress != "" && bgpASN != 0 && bgpRouterID != "" {
err := d.bgp.Configure(bgpAddress, uint32(bgpASN), net.ParseIP(bgpRouterID))
if err != nil {
return err
}
logger.Info("Started BGP server")
}
// Setup DNS listener.
d.dns = dns.NewServer(d.db.Cluster, func(name string, full bool) (*dns.Zone, error) {
// Fetch the zone.
zone, err := networkZone.LoadByName(d.State(), name)
if err != nil {
return nil, err
}
zoneInfo := zone.Info()
// Fill in the zone information.
resp := &dns.Zone{}
resp.Info = *zoneInfo
if full {
// Full content was requested.
zoneBuilder, err := zone.Content()
if err != nil {
logger.Errorf("Failed to render DNS zone %q: %v", name, err)
return nil, err
}
resp.Content = strings.TrimSpace(zoneBuilder.String())
} else {
// SOA only.
zoneBuilder, err := zone.SOA()
if err != nil {
logger.Errorf("Failed to render DNS zone %q: %v", name, err)
return nil, err
}
resp.Content = strings.TrimSpace(zoneBuilder.String())
}
return resp, nil
})
if dnsAddress != "" {
err := d.dns.Start(dnsAddress)
if err != nil {
return err
}
logger.Info("Started DNS server")
}
// Setup the networks.
if !d.serverClustered || !d.db.Cluster.LocalNodeIsEvacuated() {
logger.Infof("Initializing networks")
err = networkStartup(d.State())
if err != nil {
return err
}
}
// Setup tertiary listeners that may use managed network addresses and must be started after networks.
metricsAddress := d.localConfig.MetricsAddress()
if metricsAddress != "" {
err = d.endpoints.UpMetrics(metricsAddress)
if err != nil {
return err
}
}
storageBucketsAddress := d.localConfig.StorageBucketsAddress()
if storageBucketsAddress != "" {
err = d.endpoints.UpStorageBuckets(storageBucketsAddress)
if err != nil {
return err
}
}
// Load instance placement scriptlet.
if instancePlacementScriptlet != "" {
err = scriptletLoad.InstancePlacementSet(instancePlacementScriptlet)
if err != nil {
logger.Warn("Failed loading instance placement scriptlet", logger.Ctx{"err": err})
}
}
// Apply all patches that need to be run after networks are initialized.
err = patchesApply(d, patchPostNetworks)
if err != nil {
return err
}
// Cleanup leftover images.
pruneLeftoverImages(d.State())
var instances []instance.Instance
if !d.os.MockMode {
// Start the scheduler
go deviceEventListener(d.State)
prefixPath := os.Getenv("INCUS_DEVMONITOR_DIR")
if prefixPath == "" {
prefixPath = "/dev"
}
logger.Info("Starting device monitor")
d.devmonitor, err = fsmonitor.New(d.State().ShutdownCtx, prefixPath)
if err != nil {
return err
}
// Must occur after d.devmonitor has been initialized.
instances, err = instance.LoadNodeAll(d.State(), instancetype.Any)
if err != nil {
return fmt.Errorf("Failed loading local instances: %w", err)
}
// Register devices on running instances to receive events and reconnect to VM monitor sockets.
// This should come after the event handler go routines have been started.
devicesRegister(instances)
// Setup seccomp handler
if d.os.SeccompListener {
seccompServer, err := seccomp.NewSeccompServer(d.State(), internalUtil.RunPath("seccomp.socket"), func(pid int32, state *state.State) (seccomp.Instance, error) {
return findContainerForPid(pid, state)
})
if err != nil {
return err
}
d.seccomp = seccompServer
logger.Info("Started seccomp handler", logger.Ctx{"path": internalUtil.RunPath("seccomp.socket")})
}
// Read the trusted certificates
updateCertificateCache(d)
}
err = d.db.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
// Remove volatile.last_state.ready key as we don't know if the instances are ready.
return tx.DeleteReadyStateFromLocalInstances(ctx)
})
if err != nil {
return fmt.Errorf("Failed deleting volatile.last_state.ready: %w", err)
}
close(d.setupChan)
_ = d.db.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
// Create warnings that have been collected
for _, w := range dbWarnings {
err := tx.UpsertWarningLocalNode(ctx, "", -1, -1, warningtype.Type(w.TypeCode), w.LastMessage)
if err != nil {
logger.Warn("Failed to create warning", logger.Ctx{"err": err})
}
}
return nil
})
// Resolve warnings older than the daemon start time
err = warnings.ResolveWarningsByLocalNodeOlderThan(d.db.Cluster, d.startTime)
if err != nil {
logger.Warn("Failed to resolve warnings", logger.Ctx{"err": err})
}
// Start cluster tasks if needed.
if d.serverClustered {
d.startClusterTasks()
}
// FIXME: There's no hard reason for which we should not run these
// tasks in mock mode. However it requires that we tweak them so
// they exit gracefully without blocking (something we should do
// anyways) and they don't hit the internet or similar. Support
// for proper cancellation is something that has been started
// but has not been fully completed.
if !d.os.MockMode {
// Log expiry (daily)
d.tasks.Add(expireLogsTask(d.State()))
// Remove expired images (daily)
d.taskPruneImages = d.tasks.Add(pruneExpiredImagesTask(d))
// Auto-update images (every 6 hours, configurable)
d.tasks.Add(autoUpdateImagesTask(d))
// Auto-update instance types (daily)
d.tasks.Add(instanceRefreshTypesTask(d))
// Remove expired backups (hourly)
d.tasks.Add(pruneExpiredBackupsTask(d))
// Prune expired instance snapshots and take snapshot of instances (minutely check of configurable cron expression)
d.tasks.Add(pruneExpiredAndAutoCreateInstanceSnapshotsTask(d))
// Prune expired custom volume snapshots and take snapshots of custom volumes (minutely check of configurable cron expression)
d.tasks.Add(pruneExpiredAndAutoCreateCustomVolumeSnapshotsTask(d))
// Remove resolved warnings (daily)
d.tasks.Add(pruneResolvedWarningsTask(d))
// Auto-renew server certificate (daily)
d.tasks.Add(autoRenewCertificateTask(d))
// Remove expired tokens (hourly)
d.tasks.Add(autoRemoveExpiredTokensTask(d))
}
// Start all background tasks
d.tasks.Start(d.shutdownCtx)
// Restore instances
instancesStart(d.State(), instances)
// Re-balance in case things changed while the daemon was down
deviceTaskBalance(d.State())
// Unblock incoming requests
d.waitReady.Cancel()
logger.Info("Daemon started")
return nil
}
func (d *Daemon) startClusterTasks() {
// Add initial event listeners from global database members.
// Run asynchronously so that connecting to remote members doesn't delay starting up other cluster tasks.
go cluster.EventsUpdateListeners(d.endpoints, d.db.Cluster, d.serverCert, nil, d.events.Inject)
// Heartbeats
d.taskClusterHeartbeat = d.clusterTasks.Add(cluster.HeartbeatTask(d.gateway))
// Auto-sync images across the cluster (hourly)
d.clusterTasks.Add(autoSyncImagesTask(d.State()))
// Remove orphaned operations
d.clusterTasks.Add(autoRemoveOrphanedOperationsTask(d.State()))
// Perform automatic evacuation for offline cluster members
d.clusterTasks.Add(autoHealClusterTask(d))
// Perform automatic live-migration to alance load on cluster
d.clusterTasks.Add(autoRebalanceClusterTask(d))
// Start all background tasks
d.clusterTasks.Start(d.shutdownCtx)
}
func (d *Daemon) stopClusterTasks() {
_ = d.clusterTasks.Stop(3 * time.Second)
d.clusterTasks = task.Group{}
}
// numRunningInstances returns the number of running instances.
func (d *Daemon) numRunningInstances(instances []instance.Instance) int {
count := 0
for _, instance := range instances {
if instance.IsRunning() {
count = count + 1
}
}
return count
}
// Stop stops the shared daemon.
func (d *Daemon) Stop(ctx context.Context, sig os.Signal) error {
logger.Info("Starting shutdown sequence", logger.Ctx{"signal": sig})
// Cancelling the context will make everyone aware that we're shutting down.
d.shutdownCancel()
if d.loggingController != nil {
d.loggingController.Shutdown()
}
if d.gateway != nil {
d.stopClusterTasks()
err := handoverMemberRole(d.State(), d.gateway)
if err != nil {
logger.Warn("Could not handover member's responsibilities", logger.Ctx{"err": err})
d.gateway.Kill()
}
}
s := d.State()
// Stop any running minio processes cleanly before unmount storage pools.
miniod.StopAll()
var err error
var instances []instance.Instance
var instancesLoaded bool // If this is left as false this indicates an error loading instances.
if d.db.Cluster != nil {
instances, err = instance.LoadNodeAll(s, instancetype.Any)
if err != nil {
// List all instances on disk.
logger.Warn("Loading local instances from disk as database is not available", logger.Ctx{"err": err})
instances, err = instancesOnDisk(s)
if err != nil {
logger.Warn("Failed loading instances from disk", logger.Ctx{"err": err})
}
// Make all future queries fail fast as DB is not available.
d.gateway.Kill()
_ = d.db.Cluster.Close()
}
if err == nil {
instancesLoaded = true
}
}
// Handle shutdown (unix.SIGPWR) and reload (unix.SIGTERM) signals.
if sig == unix.SIGPWR || sig == unix.SIGTERM {
if d.db.Cluster != nil {
// waitForOperations will block until all operations are done, or it's forced to shut down.
// For the latter case, we reuse the shutdown channel which is filled when a shutdown is
// initiated using `shutdown`.
waitForOperations(ctx, d.db.Cluster, s.GlobalConfig.ShutdownTimeout())
}
// Unmount daemon image and backup volumes if set.
logger.Info("Stopping daemon storage volumes")
done := make(chan struct{})
go func() {
err := daemonStorageVolumesUnmount(s)
if err != nil {
logger.Error("Failed to unmount image and backup volumes", logger.Ctx{"err": err})
}
done <- struct{}{}
}()
// Only wait 60 seconds in case the storage backend is unreachable.
select {
case <-time.After(time.Minute):
logger.Error("Timed out waiting for image and backup volume")
case <-done:
}
// Full shutdown requested.
if sig == unix.SIGPWR {
instancesShutdown(instances)
logger.Info("Stopping networks")
networkShutdown(s)
// Unmount storage pools after instances stopped.
logger.Info("Stopping storage pools")
var pools []string
err := s.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
var err error
pools, err = tx.GetStoragePoolNames(ctx)
return err
})
if err != nil && !response.IsNotFoundError(err) {
logger.Error("Failed to get storage pools", logger.Ctx{"err": err})
}
for _, poolName := range pools {
pool, err := storagePools.LoadByName(s, poolName)
if err != nil {
logger.Error("Failed to get storage pool", logger.Ctx{"pool": poolName, "err": err})
continue
}
_, err = pool.Unmount()
if err != nil {
logger.Error("Unable to unmount storage pool", logger.Ctx{"pool": poolName, "err": err})
continue
}
}
}
}
if d.gateway != nil {
d.gateway.Kill()
}
errs := []error{}
trackError := func(err error, desc string) {
if err != nil {
errs = append(errs, fmt.Errorf(desc+": %w", err))
}
}
trackError(d.tasks.Stop(3*time.Second), "Stop tasks") // Give tasks a bit of time to cleanup.
trackError(d.clusterTasks.Stop(3*time.Second), "Stop cluster tasks") // Give tasks a bit of time to cleanup.
n := d.numRunningInstances(instances)
shouldUnmount := instancesLoaded && n <= 0
if d.db.Cluster != nil {
logger.Info("Closing the database")
err := d.db.Cluster.Close()
if err != nil {
logger.Debug("Could not close global database cleanly", logger.Ctx{"err": err})
}
}
if d.db != nil && d.db.Node != nil {
trackError(d.db.Node.Close(), "Close local database")
}
if d.gateway != nil {
trackError(d.gateway.Shutdown(), "Shutdown dqlite")
}
if d.endpoints != nil {
trackError(d.endpoints.Down(), "Shutdown endpoints")
}
if shouldUnmount {
logger.Info("Unmounting temporary filesystems")
_ = unix.Unmount(internalUtil.VarPath("guestapi"), unix.MNT_DETACH)
_ = unix.Unmount(internalUtil.VarPath("shmounts"), unix.MNT_DETACH)
logger.Info("Done unmounting temporary filesystems")
} else {
logger.Info("Not unmounting temporary filesystems (instances are still running)")
}
if d.seccomp != nil {
trackError(d.seccomp.Stop(), "Stop seccomp")
}
n = len(errs)
if n > 0 {
format := "%v"
if n > 1 {
format += fmt.Sprintf(" (and %d more errors)", n)
}
err = fmt.Errorf(format, errs[0])
}
if err != nil {
logger.Error("Failed to cleanly shutdown daemon", logger.Ctx{"err": err})
}
return err
}
// Setup OpenFGA.
func (d *Daemon) setupOpenFGA(apiURL string, apiToken string, storeID string) error {
var err error
if d.authorizer != nil {
err := d.authorizer.StopService(d.shutdownCtx)
if err != nil {
logger.Error("Failed to stop authorizer service", logger.Ctx{"error": err})
}
}
if apiURL == "" || apiToken == "" || storeID == "" {
// Reset to default authorizer.
d.authorizer, err = auth.LoadAuthorizer(d.shutdownCtx, auth.DriverTLS, logger.Log, d.clientCerts)
if err != nil {
return err
}
return nil
}
config := map[string]any{
"openfga.api.url": apiURL,
"openfga.api.token": apiToken,
"openfga.store.id": storeID,
}
reverter := revert.New()
defer reverter.Fail()
reverter.Add(func() {
// Reset to default authorizer.
d.authorizer, _ = auth.LoadAuthorizer(d.shutdownCtx, auth.DriverTLS, logger.Log, d.clientCerts)
})
// Build the list of resources to update the model.
refreshResources := func() (*auth.Resources, error) {
isLeader := false
leaderAddress, err := d.gateway.LeaderAddress()
if err != nil {
if errors.Is(err, cluster.ErrNodeIsNotClustered) {
isLeader = true
} else {
return nil, err
}
} else if leaderAddress == d.localConfig.ClusterAddress() {
isLeader = true
}
// If clustered and not running on a leader, skip the resource update.
if !isLeader {
return nil, nil
}
var resources auth.Resources
err = d.db.Cluster.Transaction(d.shutdownCtx, func(ctx context.Context, tx *db.ClusterTx) error {
err := query.Scan(ctx, tx.Tx(), "SELECT certificates.fingerprint FROM certificates", func(scan func(dest ...any) error) error {
var fingerprint string
err := scan(&fingerprint)
if err != nil {
return err
}
resources.CertificateObjects = append(resources.CertificateObjects, auth.ObjectCertificate(fingerprint))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT name FROM storage_pools", func(scan func(dest ...any) error) error {
var storagePoolName string
err := scan(&storagePoolName)
if err != nil {
return err
}
resources.StoragePoolObjects = append(resources.StoragePoolObjects, auth.ObjectStoragePool(storagePoolName))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT name FROM projects", func(scan func(dest ...any) error) error {
var projectName string
err := scan(&projectName)
if err != nil {
return err
}
resources.ProjectObjects = append(resources.ProjectObjects, auth.ObjectProject(projectName))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT images.fingerprint, projects.name FROM images JOIN projects ON projects.id=images.project_id", func(scan func(dest ...any) error) error {
var imageFingerprint string
var projectName string
err := scan(&imageFingerprint, &projectName)
if err != nil {
return err
}
resources.ImageObjects = append(resources.ImageObjects, auth.ObjectImage(projectName, imageFingerprint))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT images_aliases.name, projects.name FROM images_aliases JOIN projects ON projects.id=images_aliases.project_id", func(scan func(dest ...any) error) error {
var imageAliasName string
var projectName string
err := scan(&imageAliasName, &projectName)
if err != nil {
return err
}
resources.ImageAliasObjects = append(resources.ImageAliasObjects, auth.ObjectImageAlias(projectName, imageAliasName))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT instances.name, projects.name FROM instances JOIN projects ON projects.id=instances.project_id", func(scan func(dest ...any) error) error {
var instanceName string
var projectName string
err := scan(&instanceName, &projectName)
if err != nil {
return err
}
resources.InstanceObjects = append(resources.InstanceObjects, auth.ObjectInstance(projectName, instanceName))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT networks.name, projects.name FROM networks JOIN projects ON projects.id=networks.project_id", func(scan func(dest ...any) error) error {
var networkName string
var projectName string
err := scan(&networkName, &projectName)
if err != nil {
return err
}
resources.NetworkObjects = append(resources.NetworkObjects, auth.ObjectNetwork(projectName, networkName))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT networks_acls.name, projects.name FROM networks_acls JOIN projects ON projects.id=networks_acls.project_id", func(scan func(dest ...any) error) error {
var networkACLName string
var projectName string
err := scan(&networkACLName, &projectName)
if err != nil {
return err
}
resources.NetworkACLObjects = append(resources.NetworkACLObjects, auth.ObjectNetworkACL(projectName, networkACLName))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT networks_zones.name, projects.name FROM networks_zones JOIN projects ON projects.id=networks_zones.project_id", func(scan func(dest ...any) error) error {
var networkZoneName string
var projectName string
err := scan(&networkZoneName, &projectName)
if err != nil {
return err
}
resources.NetworkZoneObjects = append(resources.NetworkZoneObjects, auth.ObjectNetworkZone(projectName, networkZoneName))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT profiles.name, projects.name FROM profiles JOIN projects ON projects.id=profiles.project_id", func(scan func(dest ...any) error) error {
var profileName string
var projectName string
err := scan(&profileName, &projectName)
if err != nil {
return err
}
resources.ProfileObjects = append(resources.ProfileObjects, auth.ObjectProfile(projectName, profileName))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT storage_volumes.name, storage_volumes.type, storage_pools.name, projects.name, nodes.name FROM storage_volumes JOIN projects ON projects.id=storage_volumes.project_id JOIN storage_pools ON storage_pools.id=storage_volumes.storage_pool_id LEFT JOIN nodes ON storage_volumes.node_id=nodes.id", func(scan func(dest ...any) error) error {
var storageVolumeName string
var storageVolumeType int
var storageVolumeLocation sql.NullString
var storagePoolName string
var projectName string
err := scan(&storageVolumeName, &storageVolumeType, &storagePoolName, &projectName, &storageVolumeLocation)
if err != nil {
return err
}
storageVolumeTypeName, err := db.StoragePoolVolumeTypeToName(storageVolumeType)
if err != nil {
return err
}
var location string
if d.serverClustered && storageVolumeType != db.StoragePoolVolumeTypeContainer && storageVolumeType != db.StoragePoolVolumeTypeVM && storageVolumeLocation.Valid {
location = storageVolumeLocation.String
}
resources.StoragePoolVolumeObjects = append(resources.StoragePoolVolumeObjects, auth.ObjectStorageVolume(projectName, storagePoolName, storageVolumeTypeName, storageVolumeName, location))
return nil
})
if err != nil {
return err
}
err = query.Scan(ctx, tx.Tx(), "SELECT storage_buckets.name, storage_pools.name, projects.name, nodes.name FROM storage_buckets JOIN projects ON projects.id=storage_buckets.project_id JOIN storage_pools ON storage_pools.id=storage_buckets.storage_pool_id LEFT JOIN nodes ON storage_buckets.node_id=nodes.id", func(scan func(dest ...any) error) error {
var storageBucketName string
var storageBucketLocation sql.NullString
var storagePoolName string
var projectName string
err := scan(&storageBucketName, &storagePoolName, &projectName, &storageBucketLocation)
if err != nil {
return err
}
var location string
if d.serverClustered && storageBucketLocation.Valid {
location = storageBucketLocation.String
}
resources.StorageBucketObjects = append(resources.StorageBucketObjects, auth.ObjectStorageBucket(projectName, storagePoolName, storageBucketName, location))
return nil
})
if err != nil {
return err
}
return nil
})
if err != nil {
return nil, err
}
return &resources, nil
}
openfgaAuthorizer, err := auth.LoadAuthorizer(d.shutdownCtx, auth.DriverOpenFGA, logger.Log, d.clientCerts, auth.WithConfig(config), auth.WithResourcesFunc(refreshResources))
if err != nil {
return err
}
d.authorizer = openfgaAuthorizer
reverter.Success()
return nil
}
// Setup authorization scriptlet.
func (d *Daemon) setupAuthorizationScriptlet(scriptlet string) error {
err := scriptletLoad.AuthorizationSet(scriptlet)
if err != nil {
return fmt.Errorf("Failed saving authorization scriptlet: %w", err)
}
if scriptlet == "" {
// Reset to default authorizer.
d.authorizer, err = auth.LoadAuthorizer(d.shutdownCtx, auth.DriverTLS, logger.Log, d.clientCerts)
if err != nil {
return err
}
return nil
}
// Fail if not using the default tls or scriptlet authorizer.
switch d.authorizer.(type) {
case *auth.TLS, *auth.Scriptlet:
d.authorizer, err = auth.LoadAuthorizer(d.shutdownCtx, auth.DriverScriptlet, logger.Log, d.clientCerts)
if err != nil {
return err
}
default:
return errors.New("Attempting to setup scriptlet authorization while another authorizer is already set")
}
return nil
}
// Syslog listener.
func (d *Daemon) setupSyslogSocket(enable bool) error {
// Always cancel the context to ensure that no goroutines leak.
if d.syslogSocketCancel != nil {
logger.Debug("Stopping syslog socket")
d.syslogSocketCancel()
}
if !enable {
return nil
}
var ctx context.Context
ctx, d.syslogSocketCancel = context.WithCancel(d.shutdownCtx)
logger.Debug("Starting syslog socket")
err := syslog.Listen(ctx, d.events)
if err != nil {
return err
}
return nil
}
// Create a database connection and perform any updates needed.
func initializeDbObject(d *Daemon) error {
logger.Info("Initializing local database")
// Hook to run when the local database is created from scratch. It will
// create the default profile and mark all patches as applied.
freshHook := func(db *db.Node) error {
for _, patchName := range patchesGetNames() {
err := db.MarkPatchAsApplied(patchName)
if err != nil {
return err
}
}
return nil
}
var err error
d.db.Node, err = db.OpenNode(filepath.Join(d.os.VarDir, "database"), freshHook)
if err != nil {
return fmt.Errorf("Error creating database: %s", err)
}
return nil
}
// hasMemberStateChanged returns true if the number of members, their addresses or state has changed.
func (d *Daemon) hasMemberStateChanged(heartbeatData *cluster.APIHeartbeat) bool {
// No previous heartbeat data.
if d.lastNodeList == nil {
return true
}
// Member count has changed.
if len(d.lastNodeList.Members) != len(heartbeatData.Members) {
return true
}
// Check for member address or state changes.
for lastMemberID, lastMember := range d.lastNodeList.Members {
if heartbeatData.Members[lastMemberID].Address != lastMember.Address {
return true
}
if heartbeatData.Members[lastMemberID].Online != lastMember.Online {
return true
}
}
return false
}
// heartbeatHandler handles heartbeat requests from other cluster members.
func (d *Daemon) heartbeatHandler(w http.ResponseWriter, _ *http.Request, isLeader bool, hbData *cluster.APIHeartbeat) {
var err error
// Look for time skews.
now := time.Now().UTC()
if hbData.Time.Add(5*time.Second).Before(now) || hbData.Time.Add(-5*time.Second).After(now) {
if !d.timeSkew {
logger.Warn("Time skew detected between leader and local", logger.Ctx{"leaderTime": hbData.Time, "localTime": now})
if d.db.Cluster != nil {
err := d.db.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
return tx.UpsertWarningLocalNode(ctx, "", -1, -1, warningtype.ClusterTimeSkew, fmt.Sprintf("leaderTime: %s, localTime: %s", hbData.Time, now))
})
if err != nil {
logger.Warn("Failed to create cluster time skew warning", logger.Ctx{"err": err})
}
}
}
d.timeSkew = true
} else {
if d.timeSkew {
logger.Warn("Time skew resolved")
if d.db.Cluster != nil {
err := warnings.ResolveWarningsByLocalNodeAndType(d.db.Cluster, warningtype.ClusterTimeSkew)
if err != nil {
logger.Warn("Failed to resolve cluster time skew warning", logger.Ctx{"err": err})
}
}
d.timeSkew = false
}
}
// Extract the raft nodes from the heartbeat info.
raftNodes := make([]db.RaftNode, 0)
for _, node := range hbData.Members {
if node.RaftID > 0 {
raftNodes = append(raftNodes, db.RaftNode{
NodeInfo: dqliteClient.NodeInfo{
ID: node.RaftID,
Address: node.Address,
Role: db.RaftRole(node.RaftRole),
},
Name: node.Name,
})
}
}
// Check we have been sent at least 1 raft node before wiping our set.
if len(raftNodes) <= 0 {
logger.Error("Empty raft member set received")
http.Error(w, "400 Empty raft member set received", http.StatusBadRequest)
return
}
// Accept raft node list from any heartbeat type so that we get freshest data quickly.
logger.Debug("Replace current raft nodes", logger.Ctx{"raftMembers": raftNodes})
err = d.db.Node.Transaction(context.TODO(), func(ctx context.Context, tx *db.NodeTx) error {
return tx.ReplaceRaftNodes(raftNodes)
})
if err != nil {
logger.Error("Error updating raft members", logger.Ctx{"err": err})
http.Error(w, "500 failed to update raft nodes", http.StatusInternalServerError)
return
}
if hbData.FullStateList {
// If there is an ongoing heartbeat round (and by implication this is the leader), then this could
// be a problem because it could be broadcasting the stale member state information which in turn
// could lead to incorrect decisions being made. So calling heartbeatRestart will request any
// ongoing heartbeat round to cancel itself prematurely and restart another one. If there is no
// ongoing heartbeat round or this member isn't the leader then this function call is a no-op and
// will return false. If the heartbeat is restarted, then the heartbeat refresh task will be called
// at the end of the heartbeat so no need to do it here.
if !isLeader || !d.gateway.HeartbeatRestart() {
// Run heartbeat refresh task async so heartbeat response is sent to leader straight away.
go d.nodeRefreshTask(hbData, isLeader, nil)
}
} else {
if isLeader {
logger.Error("Partial heartbeat should not be sent to leader")
http.Error(w, "400 Partial heartbeat should not be sent to leader", http.StatusBadRequest)
return
}
logger.Debug("Partial heartbeat received")
}
}
// nodeRefreshTask is run when a full state heartbeat is sent (on the leader) or received (by a non-leader member).
// Is is used to check for member state changes and trigger refreshes of the certificate cache.
// It also triggers member role promotion when run on the isLeader is true.
// When run on the leader, it accepts a list of unavailableMembers that have not responded to the current heartbeat
// round (but may not be considered actually offline at this stage). These unavailable members will not be used for
// role rebalancing.
func (d *Daemon) nodeRefreshTask(heartbeatData *cluster.APIHeartbeat, isLeader bool, unavailableMembers []string) {
s := d.State()
// Don't process the heartbeat until we're fully online.
if d.db.Cluster == nil || d.db.Cluster.GetNodeID() == 0 {
return
}
localClusterAddress := s.LocalConfig.ClusterAddress()
if !heartbeatData.FullStateList || len(heartbeatData.Members) <= 0 {
logger.Error("Heartbeat member refresh task called with partial state list", logger.Ctx{"local": localClusterAddress})
return
}
if heartbeatData.Version.MinAPIExtensions > 0 && heartbeatData.Version.MinAPIExtensions != d.apiExtensions {
d.apiExtensions = heartbeatData.Version.MinAPIExtensions
}
// If the max version of the cluster has changed, check whether we need to upgrade.
if d.lastNodeList == nil || d.lastNodeList.Version.APIExtensions != heartbeatData.Version.APIExtensions || d.lastNodeList.Version.Schema != heartbeatData.Version.Schema {
err := cluster.MaybeUpdate(s)
if err != nil {
logger.Error("Error updating", logger.Ctx{"err": err})
return
}
}
stateChangeTaskFailure := false // Records whether any of the state change tasks failed.
// Handle potential OVN chassis changes.
err := networkUpdateOVNChassis(s, heartbeatData, localClusterAddress)
if err != nil {
stateChangeTaskFailure = true
logger.Error("Error restarting OVN networks", logger.Ctx{"err": err})
}
if d.hasMemberStateChanged(heartbeatData) {
logger.Info("Cluster status has changed, refreshing")
// Refresh cluster certificates cached.
updateCertificateCache(d)
}
// Refresh event listeners from heartbeat members (after certificates refreshed if needed).
// Run asynchronously so that connecting to remote members doesn't delay other heartbeat tasks.
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
cluster.EventsUpdateListeners(d.endpoints, d.db.Cluster, d.serverCert, heartbeatData.Members, d.events.Inject)
wg.Done()
}()
// Only update the node list if there are no state change task failures.
// If there are failures, then we leave the old state so that we can re-try the tasks again next heartbeat.
if !stateChangeTaskFailure {
d.lastNodeList = heartbeatData
}
// If we are leader and called from the leader heartbeat send function (unavailbleMembers != nil) and there
// are other members in the cluster, then check if we need to update roles. We do not want to do this if
// we are called on the leader as part of a notification heartbeat being received from another member.
if isLeader && unavailableMembers != nil && len(heartbeatData.Members) > 1 {
isDegraded := false
hasNodesNotPartOfRaft := false
onlineVoters := 0
onlineStandbys := 0
for _, node := range heartbeatData.Members {
role := db.RaftRole(node.RaftRole)
if node.Online {
// Count online members that have voter or stand-by raft role.
switch role {
case db.RaftVoter:
onlineVoters++
case db.RaftStandBy:
onlineStandbys++
}
if node.RaftID == 0 {
hasNodesNotPartOfRaft = true
}
} else if role != db.RaftSpare {
isDegraded = true // Offline member that has voter or stand-by raft role.
}
}
maxVoters := s.GlobalConfig.MaxVoters()
maxStandBy := s.GlobalConfig.MaxStandBy()
// If there are offline members that have voter or stand-by database roles, let's see if we can
// replace them with spare ones. Also, if we don't have enough voters or standbys, let's see if we
// can upgrade some member.
if isDegraded || onlineVoters < int(maxVoters) || onlineStandbys < int(maxStandBy) {
d.clusterMembershipMutex.Lock()
logger.Debug("Rebalancing member roles in heartbeat", logger.Ctx{"local": localClusterAddress})
err := rebalanceMemberRoles(d.State(), d.gateway, nil, unavailableMembers)
if err != nil && !errors.Is(err, cluster.ErrNotLeader) {
logger.Warn("Could not rebalance cluster member roles", logger.Ctx{"err": err, "local": localClusterAddress})
}
d.clusterMembershipMutex.Unlock()
}
if hasNodesNotPartOfRaft {
d.clusterMembershipMutex.Lock()
logger.Debug("Upgrading members without raft role in heartbeat", logger.Ctx{"local": localClusterAddress})
err := upgradeNodesWithoutRaftRole(d.State(), d.gateway)
if err != nil && !errors.Is(err, cluster.ErrNotLeader) {
logger.Warn("Failed upgrading raft roles:", logger.Ctx{"err": err, "local": localClusterAddress})
}
d.clusterMembershipMutex.Unlock()
}
}
wg.Wait()
}
func (d *Daemon) setupOVN() error {
d.ovnMu.Lock()
defer d.ovnMu.Unlock()
// Clear any existing clients.
d.ovnnb = nil
d.ovnsb = nil
// Connect to OpenVswitch.
vswitch, err := d.getOVS()
if err != nil {
return fmt.Errorf("Failed to connect to OVS: %w", err)
}
// Get the OVN southbound address.
ovnSBAddr, err := vswitch.GetOVNSouthboundDBRemoteAddress(d.shutdownCtx)
if err != nil {
return fmt.Errorf("Failed to get OVN southbound connection string: %w", err)
}
// Get the OVN northbound address.
ovnNBAddr := d.globalConfig.NetworkOVNNorthboundConnection()
// Get the SSL certificates if needed.
sslCACert, sslClientCert, sslClientKey := d.globalConfig.NetworkOVNSSL()
// Fallback to filesystem keys.
if sslCACert == "" {
content, err := os.ReadFile("/etc/ovn/ovn-central.crt")
if err == nil {
sslCACert = string(content)
}
}
if sslClientCert == "" {
content, err := os.ReadFile("/etc/ovn/cert_host")
if err == nil {
sslClientCert = string(content)
}
}
if sslClientKey == "" {
content, err := os.ReadFile("/etc/ovn/key_host")
if err == nil {
sslClientKey = string(content)
}
}
// Get OVN northbound client.
ovnnb, err := ovn.NewNB(ovnNBAddr, sslCACert, sslClientCert, sslClientKey)
if err != nil {
return err
}
// Get OVN southbound client.
ovnsb, err := ovn.NewSB(ovnSBAddr, sslCACert, sslClientCert, sslClientKey)
if err != nil {
return err
}
// Set the clients.
d.ovnnb = ovnnb
d.ovnsb = ovnsb
return nil
}
func (d *Daemon) getOVN() (*ovn.NB, *ovn.SB, error) {
if d.ovnnb == nil || d.ovnsb == nil {
err := d.setupOVN()
if err != nil {
return nil, nil, fmt.Errorf("Failed to connect to OVN: %w", err)
}
}
return d.ovnnb, d.ovnsb, nil
}
func (d *Daemon) setupOVS() error {
d.ovsMu.Lock()
defer d.ovsMu.Unlock()
// Clear any existing client.
d.ovs = nil
// Connect to OpenVswitch.
vswitch, err := ovs.NewVSwitch(d.localConfig.NetworkOVSConnection())
if err != nil {
return fmt.Errorf("Failed to connect to OVS: %w", err)
}
// Set the client.
d.ovs = vswitch
return nil
}
func (d *Daemon) getOVS() (*ovs.VSwitch, error) {
if d.ovs == nil {
err := d.setupOVS()
if err != nil {
return nil, fmt.Errorf("Failed to connect to OVS: %w", err)
}
}
return d.ovs, nil
}
|