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 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "ContentAnalysis.h"
#include "ContentAnalysisIPCTypes.h"
#include "content_analysis/sdk/analysis_client.h"
#include "base/process_util.h"
#include "GMPUtils.h" // ToHexString
#include "MainThreadUtils.h"
#include "mozilla/Array.h"
#include "mozilla/Components.h"
#include "mozilla/dom/BrowserParent.h"
#include "mozilla/dom/CanonicalBrowsingContext.h"
#include "mozilla/dom/DataTransfer.h"
#include "mozilla/dom/Directory.h"
#include "mozilla/dom/DragEvent.h"
#include "mozilla/dom/File.h"
#include "mozilla/dom/GetFilesHelper.h"
#include "mozilla/dom/Promise.h"
#include "mozilla/dom/ScriptSettings.h"
#include "mozilla/dom/WindowGlobalParent.h"
#include "mozilla/Logging.h"
#include "mozilla/ScopeExit.h"
#include "mozilla/Services.h"
#include "mozilla/SpinEventLoopUntil.h"
#include "mozilla/StaticMutex.h"
#include "mozilla/StaticPrefs_browser.h"
#include "nsAppRunner.h"
#include "nsBaseClipboard.h"
#include "nsComponentManagerUtils.h"
#include "nsIClassInfoImpl.h"
#include "nsIFile.h"
#include "nsIGlobalObject.h"
#include "nsIObserverService.h"
#include "nsIOutputStream.h"
#include "nsIPrintSettings.h"
#include "nsIStorageStream.h"
#include "nsISupportsPrimitives.h"
#include "nsITransferable.h"
#include "nsProxyRelease.h"
#include "nsThreadPool.h"
#include "ScopedNSSTypes.h"
#include "xpcpublic.h"
#include <algorithm>
#include <sstream>
#include <string>
#ifdef XP_WIN
# include <windows.h>
# define SECURITY_WIN32 1
# include <security.h>
# include "mozilla/NativeNt.h"
# include "mozilla/WinDllServices.h"
#endif // XP_WIN
namespace mozilla::contentanalysis {
LazyLogModule gContentAnalysisLog("contentanalysis");
#define LOGD(...) \
MOZ_LOG(mozilla::contentanalysis::gContentAnalysisLog, \
mozilla::LogLevel::Debug, (__VA_ARGS__))
#define LOGE(...) \
MOZ_LOG(mozilla::contentanalysis::gContentAnalysisLog, \
mozilla::LogLevel::Error, (__VA_ARGS__))
} // namespace mozilla::contentanalysis
namespace {
const char* kPipePathNamePref = "browser.contentanalysis.pipe_path_name";
const char* kClientSignature = "browser.contentanalysis.client_signature";
const char* kAllowUrlPref = "browser.contentanalysis.allow_url_regex_list";
const char* kDenyUrlPref = "browser.contentanalysis.deny_url_regex_list";
const char* kAgentNamePref = "browser.contentanalysis.agent_name";
const char* kInterceptionPointPrefNames[] = {
"browser.contentanalysis.interception_point.clipboard.enabled",
"browser.contentanalysis.interception_point.download.enabled",
"browser.contentanalysis.interception_point.drag_and_drop.enabled",
"browser.contentanalysis.interception_point.file_upload.enabled",
"browser.contentanalysis.interception_point.print.enabled",
};
// Allow up to this many threads to be concurrently engaged in synchronous
// communcations with the agent. That limit is set by
// browser.contentanalysis.max_connections but is clamped to not exceed
// this value.
const unsigned long kMaxContentAnalysisAgentThreads = 256;
// Max number of threads that we keep even if they have no tasks to run.
const unsigned long kMaxIdleContentAnalysisAgentThreads = 2;
// Time (ms) we wait before declaring a thread idle. 100ms is the
// threadpool default.
const unsigned long kIdleContentAnalysisAgentTimeoutMs = 100;
// Time we wait before destroying the kMaxIdleContentAnalysisAgentThreads
// threads. Content Analysis never does this, which is what UINT32_MAX
// means.
const unsigned long kMaxIdleContentAnalysisAgentTimeoutMs = UINT32_MAX;
// How long the threadpool will wait at shutdown for the agent to complete any
// in-progress operations before it abandons the threads (they will keep
// running).
const uint32_t kShutdownThreadpoolTimeoutMs = 2 * 1000;
// kTextMime must be the first entry.
auto kTextFormatsToAnalyze = {kTextMime, kHTMLMime};
const char* SafeGetStaticErrorName(nsresult aRv) {
const auto* ret = mozilla::GetStaticErrorName(aRv);
return ret ? ret : "<illegal value>";
}
nsresult MakePromise(JSContext* aCx, mozilla::dom::Promise** aPromise) {
nsIGlobalObject* go = xpc::CurrentNativeGlobal(aCx);
if (NS_WARN_IF(!go)) {
return NS_ERROR_UNEXPECTED;
}
mozilla::ErrorResult result;
RefPtr promise = mozilla::dom::Promise::Create(go, result);
if (NS_WARN_IF(result.Failed())) {
return result.StealNSResult();
}
promise.forget(aPromise);
return NS_OK;
}
static nsCString GenerateUUID() {
nsID id = nsID::GenerateUUID();
return nsCString(id.ToString().get());
}
static nsresult GetFileDisplayName(const nsString& aFilePath,
nsString& aFileDisplayName) {
nsCOMPtr<nsIFile> file;
MOZ_TRY(NS_NewLocalFile(aFilePath, getter_AddRefs(file)));
return file->GetDisplayName(aFileDisplayName);
}
nsIContentAnalysisAcknowledgement::FinalAction ConvertResult(
nsIContentAnalysisResponse::Action aResponseResult) {
switch (aResponseResult) {
case nsIContentAnalysisResponse::Action::eReportOnly:
return nsIContentAnalysisAcknowledgement::FinalAction::eReportOnly;
case nsIContentAnalysisResponse::Action::eWarn:
return nsIContentAnalysisAcknowledgement::FinalAction::eWarn;
case nsIContentAnalysisResponse::Action::eBlock:
case nsIContentAnalysisResponse::Action::eCanceled:
return nsIContentAnalysisAcknowledgement::FinalAction::eBlock;
case nsIContentAnalysisResponse::Action::eAllow:
return nsIContentAnalysisAcknowledgement::FinalAction::eAllow;
case nsIContentAnalysisResponse::Action::eUnspecified:
return nsIContentAnalysisAcknowledgement::FinalAction::eUnspecified;
default:
LOGE(
"ConvertResult got unexpected responseResult "
"%d",
static_cast<uint32_t>(aResponseResult));
return nsIContentAnalysisAcknowledgement::FinalAction::eUnspecified;
}
}
bool SourceIsSameTab(nsIContentAnalysisRequest* aRequest) {
RefPtr<mozilla::dom::WindowGlobalParent> sourceWindowGlobal;
MOZ_ALWAYS_SUCCEEDS(
aRequest->GetSourceWindowGlobal(getter_AddRefs(sourceWindowGlobal)));
if (!sourceWindowGlobal) {
return false;
}
RefPtr<mozilla::dom::WindowGlobalParent> windowGlobal;
MOZ_ALWAYS_SUCCEEDS(
aRequest->GetWindowGlobalParent(getter_AddRefs(windowGlobal)));
return windowGlobal->GetBrowsingContext()->Top() ==
sourceWindowGlobal->GetBrowsingContext()->Top() &&
windowGlobal->DocumentPrincipal() &&
windowGlobal->DocumentPrincipal()->Subsumes(
sourceWindowGlobal->DocumentPrincipal());
}
} // anonymous namespace
/* static */ bool nsIContentAnalysis::MightBeActive() {
// A DLP connection is not permitted to be added/removed while the
// browser is running, so we can cache this.
// Furthermore, if this is set via enterprise policy the pref will be locked
// so users won't be able to change it.
// Ideally we would make this a mirror: once pref, but this interacts in
// some weird ways with the enterprise policy for testing purposes.
static bool sIsEnabled =
mozilla::StaticPrefs::browser_contentanalysis_enabled();
// Note that we can't check gAllowContentAnalysis here because it
// only gets set in the parent process.
return sIsEnabled;
}
namespace mozilla::contentanalysis {
ContentAnalysisRequest::~ContentAnalysisRequest() {
#ifdef XP_WIN
CloseHandle(mPrintDataHandle);
#endif
}
NS_IMETHODIMP
ContentAnalysisRequest::GetAnalysisType(AnalysisType* aAnalysisType) {
*aAnalysisType = mAnalysisType;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetReason(Reason* aReason) {
*aReason = mReason;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetTextContent(nsAString& aTextContent) {
aTextContent = mTextContent;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetFilePath(nsAString& aFilePath) {
aFilePath = mFilePath;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetPrintDataHandle(uint64_t* aPrintDataHandle) {
#ifdef XP_WIN
uintptr_t printDataHandle = reinterpret_cast<uintptr_t>(mPrintDataHandle);
uint64_t printDataValue = static_cast<uint64_t>(printDataHandle);
*aPrintDataHandle = printDataValue;
return NS_OK;
#else
return NS_ERROR_NOT_IMPLEMENTED;
#endif
}
NS_IMETHODIMP
ContentAnalysisRequest::GetPrinterName(nsAString& aPrinterName) {
aPrinterName = mPrinterName;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetPrintDataSize(uint64_t* aPrintDataSize) {
#ifdef XP_WIN
*aPrintDataSize = mPrintDataSize;
return NS_OK;
#else
return NS_ERROR_NOT_IMPLEMENTED;
#endif
}
NS_IMETHODIMP
ContentAnalysisRequest::GetUrl(nsIURI** aUrl) {
NS_ENSURE_ARG_POINTER(aUrl);
NS_IF_ADDREF(*aUrl = mUrl);
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetEmail(nsAString& aEmail) {
aEmail = mEmail;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetSha256Digest(nsACString& aSha256Digest) {
aSha256Digest = mSha256Digest;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetResources(
nsTArray<RefPtr<nsIClientDownloadResource>>& aResources) {
aResources = mResources.Clone();
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetRequestToken(nsACString& aRequestToken) {
aRequestToken = mRequestToken;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::SetRequestToken(const nsACString& aRequestToken) {
mRequestToken = aRequestToken;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetUserActionId(nsACString& aUserActionId) {
aUserActionId = mUserActionId;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::SetUserActionId(const nsACString& aUserActionId) {
mUserActionId = aUserActionId;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetUserActionRequestsCount(
int64_t* aUserActionRequestsCount) {
NS_ENSURE_ARG_POINTER(aUserActionRequestsCount);
*aUserActionRequestsCount = mUserActionRequestsCount;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::SetUserActionRequestsCount(
int64_t aUserActionRequestsCount) {
mUserActionRequestsCount = aUserActionRequestsCount;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetOperationTypeForDisplay(
OperationType* aOperationType) {
*aOperationType = mOperationTypeForDisplay;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetFileNameForDisplay(nsAString& aFileNameForDisplay) {
aFileNameForDisplay = mFileNameForDisplay;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetWindowGlobalParent(
dom::WindowGlobalParent** aWindowGlobalParent) {
NS_IF_ADDREF(*aWindowGlobalParent = mWindowGlobalParent);
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetSourceWindowGlobal(
mozilla::dom::WindowGlobalParent** aSourceWindowGlobal) {
NS_IF_ADDREF(*aSourceWindowGlobal = mSourceWindowGlobal);
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetTransferable(nsITransferable** aTransferable) {
NS_IF_ADDREF(*aTransferable = mTransferable);
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetDataTransfer(
mozilla::dom::DataTransfer** aDataTransfer) {
NS_IF_ADDREF(*aDataTransfer = mDataTransfer);
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::SetDataTransfer(
mozilla::dom::DataTransfer* aDataTransfer) {
mDataTransfer = aDataTransfer;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetTimeoutMultiplier(uint32_t* aTimeoutMultiplier) {
NS_ENSURE_ARG_POINTER(aTimeoutMultiplier);
*aTimeoutMultiplier = mTimeoutMultiplier;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::SetTimeoutMultiplier(uint32_t aTimeoutMultiplier) {
mTimeoutMultiplier = aTimeoutMultiplier;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::GetTestOnlyIgnoreCanceledAndAlwaysSubmitToAgent(
bool* aAlwaysSubmitToAgent) {
*aAlwaysSubmitToAgent = mTestOnlyAlwaysSubmitToAgent;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisRequest::SetTestOnlyIgnoreCanceledAndAlwaysSubmitToAgent(
bool aAlwaysSubmitToAgent) {
mTestOnlyAlwaysSubmitToAgent = aAlwaysSubmitToAgent;
return NS_OK;
}
nsresult ContentAnalysis::CreateContentAnalysisClient(
nsCString&& aPipePathName, nsString&& aClientSignatureSetting,
bool aIsPerUser) {
MOZ_ASSERT(!NS_IsMainThread());
std::shared_ptr<content_analysis::sdk::Client> client;
bool isShutDown = IsShutDown();
if (!isShutDown) {
client.reset(content_analysis::sdk::Client::Create(
{aPipePathName.Data(), aIsPerUser})
.release());
LOGD("Content analysis is %s", client ? "connected" : "not available");
} else {
LOGD("ContentAnalysis::IsShutDown is true");
}
#ifdef XP_WIN
if (client && !aClientSignatureSetting.IsEmpty()) {
std::string agentPath = client->GetAgentInfo().binary_path;
nsString agentWidePath = NS_ConvertUTF8toUTF16(agentPath);
UniquePtr<wchar_t[]> orgName =
mozilla::DllServices::Get()->GetBinaryOrgName(agentWidePath.Data());
bool signatureMatches = false;
if (orgName) {
auto dependentOrgName = nsDependentString(orgName.get());
LOGD("Content analysis client signed with organization name \"%S\"",
dependentOrgName.getW());
signatureMatches = aClientSignatureSetting.Equals(dependentOrgName);
} else {
LOGD("Content analysis client has no signature");
}
if (!signatureMatches) {
LOGE(
"Got mismatched content analysis client signature! All content "
"analysis operations will fail.");
nsresult rv = NS_ERROR_INVALID_SIGNATURE;
glean::content_analysis::connection_failure
.Get(nsCString{SafeGetStaticErrorName(rv)})
.Add();
NS_DispatchToMainThread(
NS_NewRunnableFunction(__func__, [self = RefPtr{this}, rv]() {
AssertIsOnMainThread();
self->mCaClientPromise->Reject(rv, __func__);
self->mCreatingClient = false;
}));
return NS_OK;
}
}
#endif // XP_WIN
NS_DispatchToMainThread(NS_NewRunnableFunction(
__func__,
[self = RefPtr{this}, isShutDown, client = std::move(client)]() {
AssertIsOnMainThread();
// Note that if mCaClientPromise has been resolved or rejected
// calling Resolve() or Reject() is a noop.
if (client) {
self->mHaveResolvedClientPromise = true;
self->mCaClientPromise->Resolve(client, __func__);
} else {
nsresult promiseResult = isShutDown ? NS_ERROR_ILLEGAL_DURING_SHUTDOWN
: NS_ERROR_CONNECTION_REFUSED;
glean::content_analysis::connection_failure
.Get(nsCString{SafeGetStaticErrorName(promiseResult)})
.Add();
self->mCaClientPromise->Reject(promiseResult, __func__);
}
self->mCreatingClient = false;
}));
return NS_OK;
}
ContentAnalysisRequest::ContentAnalysisRequest(
AnalysisType aAnalysisType, Reason aReason, nsString aString,
bool aStringIsFilePath, nsCString aSha256Digest, nsCOMPtr<nsIURI> aUrl,
OperationType aOperationType, dom::WindowGlobalParent* aWindowGlobalParent,
dom::WindowGlobalParent* aSourceWindowGlobal, nsCString&& aUserActionId)
: mAnalysisType(aAnalysisType),
mReason(aReason),
mUrl(std::move(aUrl)),
mSha256Digest(std::move(aSha256Digest)),
mUserActionId(std::move(aUserActionId)),
mOperationTypeForDisplay(aOperationType),
mWindowGlobalParent(aWindowGlobalParent),
mSourceWindowGlobal(aSourceWindowGlobal) {
MOZ_ASSERT(aAnalysisType != AnalysisType::ePrint,
"Print should use other ContentAnalysisRequest constructor!");
MOZ_ASSERT(aReason != nsIContentAnalysisRequest::Reason::ePrintPreviewPrint &&
aReason != nsIContentAnalysisRequest::Reason::eSystemDialogPrint);
if (aStringIsFilePath) {
mFilePath = std::move(aString);
} else {
mTextContent = std::move(aString);
}
if (mOperationTypeForDisplay == OperationType::eUpload ||
mOperationTypeForDisplay == OperationType::eDownload) {
MOZ_ASSERT(aStringIsFilePath);
nsresult rv = GetFileDisplayName(mFilePath, mFileNameForDisplay);
if (NS_FAILED(rv)) {
mFileNameForDisplay = u"file";
}
}
}
ContentAnalysisRequest::ContentAnalysisRequest(
AnalysisType aAnalysisType, Reason aReason, nsITransferable* aTransferable,
dom::WindowGlobalParent* aWindowGlobalParent,
dom::WindowGlobalParent* aSourceWindowGlobal)
: mAnalysisType(aAnalysisType),
mReason(aReason),
mTransferable(aTransferable),
mOperationTypeForDisplay(
nsIContentAnalysisRequest::OperationType::eClipboard),
mWindowGlobalParent(aWindowGlobalParent),
mSourceWindowGlobal(aSourceWindowGlobal) {}
ContentAnalysisRequest::ContentAnalysisRequest(
const nsTArray<uint8_t> aPrintData, nsCOMPtr<nsIURI> aUrl,
nsString aPrinterName, Reason aReason,
dom::WindowGlobalParent* aWindowGlobalParent)
: mAnalysisType(AnalysisType::ePrint),
mReason(aReason),
mUrl(std::move(aUrl)),
mPrinterName(std::move(aPrinterName)),
mWindowGlobalParent(aWindowGlobalParent) {
#ifdef XP_WIN
LARGE_INTEGER dataContentLength;
dataContentLength.QuadPart = static_cast<LONGLONG>(aPrintData.Length());
mPrintDataHandle = ::CreateFileMappingW(
INVALID_HANDLE_VALUE, nullptr, PAGE_READWRITE, dataContentLength.HighPart,
dataContentLength.LowPart, nullptr);
if (mPrintDataHandle) {
mozilla::nt::AutoMappedView view(mPrintDataHandle, FILE_MAP_ALL_ACCESS);
memcpy(view.as<uint8_t>(), aPrintData.Elements(), aPrintData.Length());
mPrintDataSize = aPrintData.Length();
}
#else
MOZ_ASSERT_UNREACHABLE(
"Content Analysis is not supported on non-Windows platforms");
#endif
// We currently only use this constructor when printing.
MOZ_ASSERT(aReason == nsIContentAnalysisRequest::Reason::ePrintPreviewPrint ||
aReason == nsIContentAnalysisRequest::Reason::eSystemDialogPrint);
mOperationTypeForDisplay = OperationType::eOperationPrint;
}
RefPtr<ContentAnalysisRequest> ContentAnalysisRequest::Clone(
nsIContentAnalysisRequest* aRequest) {
auto clone = MakeRefPtr<ContentAnalysisRequest>();
MOZ_ALWAYS_SUCCEEDS(aRequest->GetAnalysisType(&clone->mAnalysisType));
MOZ_ALWAYS_SUCCEEDS(aRequest->GetReason(&clone->mReason));
MOZ_ALWAYS_SUCCEEDS(
aRequest->GetTransferable(getter_AddRefs(clone->mTransferable)));
MOZ_ALWAYS_SUCCEEDS(
aRequest->GetDataTransfer(getter_AddRefs(clone->mDataTransfer)));
MOZ_ALWAYS_SUCCEEDS(aRequest->GetTextContent(clone->mTextContent));
MOZ_ALWAYS_SUCCEEDS(aRequest->GetFilePath(clone->mFilePath));
MOZ_ALWAYS_SUCCEEDS(aRequest->GetUrl(getter_AddRefs(clone->mUrl)));
MOZ_ALWAYS_SUCCEEDS(aRequest->GetSha256Digest(clone->mSha256Digest));
MOZ_ALWAYS_SUCCEEDS(aRequest->GetResources(clone->mResources));
MOZ_ALWAYS_SUCCEEDS(aRequest->GetEmail(clone->mEmail));
// Do not copy mRequestToken or mUserActionId or mUserActionIdCount
MOZ_ALWAYS_SUCCEEDS(
aRequest->GetOperationTypeForDisplay(&clone->mOperationTypeForDisplay));
MOZ_ALWAYS_SUCCEEDS(
aRequest->GetFileNameForDisplay(clone->mFileNameForDisplay));
MOZ_ALWAYS_SUCCEEDS(aRequest->GetPrinterName(clone->mPrinterName));
MOZ_ALWAYS_SUCCEEDS(aRequest->GetWindowGlobalParent(
getter_AddRefs(clone->mWindowGlobalParent)));
#ifdef XP_WIN
uint64_t printDataValue;
MOZ_ALWAYS_SUCCEEDS(aRequest->GetPrintDataHandle(&printDataValue));
uintptr_t printDataHandle = static_cast<uint64_t>(printDataValue);
clone->mPrintDataHandle = reinterpret_cast<HANDLE>(printDataHandle);
MOZ_ALWAYS_SUCCEEDS(aRequest->GetPrintDataSize(&clone->mPrintDataSize));
#endif
MOZ_ALWAYS_SUCCEEDS(aRequest->GetSourceWindowGlobal(
getter_AddRefs(clone->mSourceWindowGlobal)));
// Do not copy mTimeoutMultiplier
MOZ_ALWAYS_SUCCEEDS(aRequest->GetTestOnlyIgnoreCanceledAndAlwaysSubmitToAgent(
&clone->mTestOnlyAlwaysSubmitToAgent));
return clone;
}
nsresult ContentAnalysisRequest::GetFileDigest(const nsAString& aFilePath,
nsCString& aDigestString) {
MOZ_DIAGNOSTIC_ASSERT(
!NS_IsMainThread(),
"ContentAnalysisRequest::GetFileDigest does file IO and should "
"not run on the main thread");
nsresult rv;
mozilla::Digest digest;
digest.Begin(SEC_OID_SHA256);
PRFileDesc* fd = nullptr;
nsCOMPtr<nsIFile> file;
MOZ_TRY(NS_NewLocalFile(aFilePath, getter_AddRefs(file)));
rv = file->OpenNSPRFileDesc(PR_RDONLY | nsIFile::OS_READAHEAD, 0, &fd);
NS_ENSURE_SUCCESS(rv, rv);
auto closeFile = MakeScopeExit([fd]() { PR_Close(fd); });
constexpr uint32_t kBufferSize = 1024 * 1024;
auto buffer = mozilla::MakeUnique<uint8_t[]>(kBufferSize);
if (!buffer) {
return NS_ERROR_OUT_OF_MEMORY;
}
PRInt32 bytesRead = PR_Read(fd, buffer.get(), kBufferSize);
while (bytesRead != 0) {
if (bytesRead == -1) {
return NS_ErrorAccordingToNSPR();
}
digest.Update(mozilla::Span<const uint8_t>(buffer.get(), bytesRead));
bytesRead = PR_Read(fd, buffer.get(), kBufferSize);
}
nsTArray<uint8_t> digestResults;
rv = digest.End(digestResults);
NS_ENSURE_SUCCESS(rv, rv);
aDigestString = mozilla::ToHexString(digestResults);
return NS_OK;
}
static nsresult ConvertToProtobuf(
nsIClientDownloadResource* aIn,
content_analysis::sdk::ClientDownloadRequest_Resource* aOut) {
nsString url;
nsresult rv = aIn->GetUrl(url);
NS_ENSURE_SUCCESS(rv, rv);
aOut->set_url(NS_ConvertUTF16toUTF8(url).get());
uint32_t resourceType;
rv = aIn->GetType(&resourceType);
NS_ENSURE_SUCCESS(rv, rv);
aOut->set_type(
static_cast<content_analysis::sdk::ClientDownloadRequest_ResourceType>(
resourceType));
return NS_OK;
}
#if defined(DEBUG)
static bool IsRequestReadyForAgent(nsIContentAnalysisRequest* aRequest) {
NS_ENSURE_TRUE(aRequest, false);
// The windowGlobal is allowed to be null at this point in gtests (only).
// The URL must be set in that case. We check that below.
RefPtr<dom::WindowGlobalParent> windowGlobal;
NS_ENSURE_SUCCESS(
aRequest->GetWindowGlobalParent(getter_AddRefs(windowGlobal)), false);
// Any DataTransfer should have been expanded into individual requests.
nsCOMPtr<dom::DataTransfer> dataTransfer;
NS_ENSURE_SUCCESS(aRequest->GetDataTransfer(getter_AddRefs(dataTransfer)),
false);
NS_ENSURE_TRUE(!dataTransfer, false);
// Any nsITransferable should have been expanded into individual requests.
nsCOMPtr<nsITransferable> transferable;
NS_ENSURE_SUCCESS(aRequest->GetTransferable(getter_AddRefs(transferable)),
false);
NS_ENSURE_TRUE(!transferable, false);
nsCString userActionId;
NS_ENSURE_SUCCESS(aRequest->GetUserActionId(userActionId), false);
NS_ENSURE_TRUE(!userActionId.IsEmpty(), false);
int64_t userActionRequestsCount;
NS_ENSURE_SUCCESS(
aRequest->GetUserActionRequestsCount(&userActionRequestsCount), false);
NS_ENSURE_TRUE(userActionRequestsCount, false);
nsCOMPtr<nsIURI> url;
NS_ENSURE_SUCCESS(aRequest->GetUrl(getter_AddRefs(url)), false);
if (!url) {
// If no URL is given then we use the one for the window.
NS_ENSURE_TRUE(windowGlobal, false);
url = ContentAnalysis::GetURIForBrowsingContext(
windowGlobal->Canonical()->GetBrowsingContext());
NS_ENSURE_TRUE(url, false);
}
return true;
}
#endif // defined(DEBUG)
static nsresult ConvertToProtobuf(
nsIContentAnalysisRequest* aIn,
content_analysis::sdk::ContentAnalysisRequest* aOut) {
MOZ_ASSERT(IsRequestReadyForAgent(aIn));
nsIContentAnalysisRequest::AnalysisType analysisType;
nsresult rv = aIn->GetAnalysisType(&analysisType);
NS_ENSURE_SUCCESS(rv, rv);
auto connector =
static_cast<content_analysis::sdk::AnalysisConnector>(analysisType);
aOut->set_analysis_connector(connector);
nsIContentAnalysisRequest::Reason reason;
rv = aIn->GetReason(&reason);
NS_ENSURE_SUCCESS(rv, rv);
auto sdkReason =
static_cast<content_analysis::sdk::ContentAnalysisRequest::Reason>(
reason);
aOut->set_reason(sdkReason);
nsCString requestToken;
rv = aIn->GetRequestToken(requestToken);
NS_ENSURE_SUCCESS(rv, rv);
aOut->set_request_token(requestToken.get(), requestToken.Length());
nsCString userActionId;
rv = aIn->GetUserActionId(userActionId);
NS_ENSURE_SUCCESS(rv, rv);
aOut->set_user_action_id(userActionId.get(), userActionId.Length());
int64_t userActionRequestsCount;
rv = aIn->GetUserActionRequestsCount(&userActionRequestsCount);
NS_ENSURE_SUCCESS(rv, rv);
aOut->set_user_action_requests_count(userActionRequestsCount);
int32_t timeout = StaticPrefs::browser_contentanalysis_agent_timeout();
// Non-positive timeout values indicate testing, and the test agent does not
// care about this value.
timeout = std::max(timeout, 1);
uint32_t timeoutMultiplier;
rv = aIn->GetTimeoutMultiplier(&timeoutMultiplier);
NS_ENSURE_SUCCESS(rv, rv);
timeoutMultiplier = std::max(timeoutMultiplier, static_cast<uint32_t>(1));
auto checkedTimeout = CheckedInt64(time(nullptr)) +
timeout * userActionRequestsCount * timeoutMultiplier;
if (!checkedTimeout.isValid()) {
return NS_ERROR_FAILURE;
}
aOut->set_expires_at(checkedTimeout.value());
const std::string tag = "dlp"; // TODO:
*aOut->add_tags() = tag;
auto* requestData = aOut->mutable_request_data();
RefPtr<dom::WindowGlobalParent> windowGlobal;
rv = aIn->GetWindowGlobalParent(getter_AddRefs(windowGlobal));
NS_ENSURE_SUCCESS(rv, rv);
nsCOMPtr<nsIURI> url;
rv = aIn->GetUrl(getter_AddRefs(url));
NS_ENSURE_SUCCESS(rv, rv);
if (!url) {
// We already checked that this exists.
MOZ_ASSERT(windowGlobal);
// If no URL is given then we use the one for the window.
url = ContentAnalysis::GetURIForBrowsingContext(
windowGlobal->Canonical()->GetBrowsingContext());
// We also already checked for this.
MOZ_ASSERT(url);
}
nsCString urlString;
rv = url->GetSpec(urlString);
NS_ENSURE_SUCCESS(rv, rv);
if (!urlString.IsEmpty()) {
requestData->set_url(urlString.get());
}
if (windowGlobal) {
nsString title;
windowGlobal->GetDocumentTitle(title);
requestData->set_tab_title(NS_ConvertUTF16toUTF8(title).get());
}
nsString email;
rv = aIn->GetEmail(email);
NS_ENSURE_SUCCESS(rv, rv);
if (!email.IsEmpty()) {
requestData->set_email(NS_ConvertUTF16toUTF8(email).get());
}
nsCString sha256Digest;
rv = aIn->GetSha256Digest(sha256Digest);
NS_ENSURE_SUCCESS(rv, rv);
if (!sha256Digest.IsEmpty()) {
requestData->set_digest(sha256Digest.get());
}
if (analysisType == nsIContentAnalysisRequest::AnalysisType::ePrint) {
#if XP_WIN
uint64_t printDataHandle;
MOZ_TRY(aIn->GetPrintDataHandle(&printDataHandle));
if (!printDataHandle) {
return NS_ERROR_OUT_OF_MEMORY;
}
aOut->mutable_print_data()->set_handle(printDataHandle);
uint64_t printDataSize;
MOZ_TRY(aIn->GetPrintDataSize(&printDataSize));
aOut->mutable_print_data()->set_size(printDataSize);
nsString printerName;
MOZ_TRY(aIn->GetPrinterName(printerName));
requestData->mutable_print_metadata()->set_printer_name(
NS_ConvertUTF16toUTF8(printerName).get());
#else
return NS_ERROR_NOT_IMPLEMENTED;
#endif
} else {
nsString filePath;
rv = aIn->GetFilePath(filePath);
NS_ENSURE_SUCCESS(rv, rv);
if (!filePath.IsEmpty()) {
std::string filePathStr = NS_ConvertUTF16toUTF8(filePath).get();
aOut->set_file_path(filePathStr);
auto filename = filePathStr.substr(filePathStr.find_last_of("/\\") + 1);
if (!filename.empty()) {
requestData->set_filename(filename);
}
} else {
nsString textContent;
rv = aIn->GetTextContent(textContent);
NS_ENSURE_SUCCESS(rv, rv);
MOZ_ASSERT(!textContent.IsEmpty());
aOut->set_text_content(NS_ConvertUTF16toUTF8(textContent).get());
}
}
#ifdef XP_WIN
ULONG userLen = 0;
GetUserNameExW(NameSamCompatible, nullptr, &userLen);
if (GetLastError() == ERROR_MORE_DATA && userLen > 0) {
auto user = mozilla::MakeUnique<wchar_t[]>(userLen);
if (GetUserNameExW(NameSamCompatible, user.get(), &userLen)) {
auto* clientMetadata = aOut->mutable_client_metadata();
auto* browser = clientMetadata->mutable_browser();
browser->set_machine_user(NS_ConvertUTF16toUTF8(user.get()).get());
}
}
#endif
nsTArray<RefPtr<nsIClientDownloadResource>> resources;
rv = aIn->GetResources(resources);
NS_ENSURE_SUCCESS(rv, rv);
if (!resources.IsEmpty()) {
auto* pbClientDownloadRequest = requestData->mutable_csd();
for (auto& nsResource : resources) {
rv = ConvertToProtobuf(nsResource.get(),
pbClientDownloadRequest->add_resources());
NS_ENSURE_SUCCESS(rv, rv);
}
}
return NS_OK;
}
namespace {
// We don't want this overload to be called for string parameters, so
// use std::enable_if
template <typename T>
typename std::enable_if_t<!std::is_same<std::string, std::decay_t<T>>::value,
void>
LogWithMaxLength(std::stringstream& ss, T value, size_t maxLength) {
ss << value;
}
// 0 indicates no max length
template <typename T>
typename std::enable_if_t<std::is_same<std::string, std::decay_t<T>>::value,
void>
LogWithMaxLength(std::stringstream& ss, T value, size_t maxLength) {
if (!maxLength || value.length() < maxLength) {
ss << value;
} else {
ss << value.substr(0, maxLength) << " (truncated)";
}
}
} // namespace
static void LogRequest(
const content_analysis::sdk::ContentAnalysisRequest* aPbRequest) {
// We cannot use Protocol Buffer's DebugString() because we optimize for
// lite runtime.
if (!static_cast<LogModule*>(gContentAnalysisLog)
->ShouldLog(LogLevel::Debug)) {
return;
}
std::stringstream ss;
ss << "ContentAnalysisRequest:"
<< "\n";
#define ADD_FIELD_WITH_VALFUNC(PBUF, NAME, FUNC, VALFUNC) \
ss << " " << (NAME) << ": "; \
if ((PBUF)->has_##FUNC()) { \
LogWithMaxLength(ss, VALFUNC(), 500); \
ss << "\n"; \
} else \
ss << "<none>" \
<< "\n";
#define ADD_FIELD(PBUF, NAME, FUNC) \
ADD_FIELD_WITH_VALFUNC(PBUF, NAME, FUNC, (PBUF)->FUNC)
#define ADD_EXISTS(PBUF, NAME, FUNC) \
ss << " " << (NAME) << ": " \
<< ((PBUF)->has_##FUNC() ? "<exists>" : "<none>") << "\n";
#define ADD_NONEMPTY(PBUF, NAME, FUNC) \
ss << " " << (NAME) << ": " \
<< (((PBUF)->has_##FUNC() && (!(PBUF)->FUNC().empty())) ? "<nonempty>" \
: "<none>") \
<< "\n";
ADD_FIELD(aPbRequest, "Expires", expires_at);
ADD_FIELD(aPbRequest, "Analysis Type", analysis_connector);
ADD_FIELD(aPbRequest, "Request Token", request_token);
ADD_FIELD(aPbRequest, "User Action ID", user_action_id);
ADD_FIELD(aPbRequest, "User Action Requests Count",
user_action_requests_count);
ADD_FIELD(aPbRequest, "File Path", file_path);
ADD_NONEMPTY(aPbRequest, "Text Content", text_content);
// TODO: Tags
ADD_EXISTS(aPbRequest, "Request Data Struct", request_data);
const auto* requestData =
aPbRequest->has_request_data() ? &aPbRequest->request_data() : nullptr;
if (requestData) {
ADD_FIELD(requestData, " Url", url);
ADD_FIELD(requestData, " Email", email);
auto hexDigestFunc = [&requestData]() {
return ToHexString(
reinterpret_cast<const uint8_t*>(requestData->digest().c_str()),
requestData->digest().length());
};
ADD_FIELD_WITH_VALFUNC(requestData, " SHA-256 Digest", digest,
hexDigestFunc);
ADD_FIELD(requestData, " Filename", filename);
ADD_EXISTS(requestData, " Client Download Request struct", csd);
const auto* csd = requestData->has_csd() ? &requestData->csd() : nullptr;
if (csd) {
uint32_t i = 0;
for (const auto& resource : csd->resources()) {
ss << " Resource " << i << ":"
<< "\n";
ADD_FIELD(&resource, " Url", url);
ADD_FIELD(&resource, " Type", type);
++i;
}
}
}
ADD_EXISTS(aPbRequest, "Client Metadata Struct", client_metadata);
const auto* clientMetadata = aPbRequest->has_client_metadata()
? &aPbRequest->client_metadata()
: nullptr;
if (clientMetadata) {
ADD_EXISTS(clientMetadata, " Browser Struct", browser);
const auto* browser =
clientMetadata->has_browser() ? &clientMetadata->browser() : nullptr;
if (browser) {
ADD_FIELD(browser, " Machine User", machine_user);
}
}
#undef ADD_EXISTS
#undef ADD_FIELD
LOGD("%s", ss.str().c_str());
}
ContentAnalysisResponse::ContentAnalysisResponse(
content_analysis::sdk::ContentAnalysisResponse&& aResponse,
const nsCString& aUserActionId)
: mUserActionId(aUserActionId) {
mAction = Action::eUnspecified;
for (const auto& result : aResponse.results()) {
if (!result.has_status() ||
result.status() !=
content_analysis::sdk::ContentAnalysisResponse::Result::SUCCESS) {
mAction = Action::eUnspecified;
return;
}
// The action values increase with severity, so the max is the most severe.
for (const auto& rule : result.triggered_rules()) {
mAction =
static_cast<Action>(std::max(static_cast<uint32_t>(mAction),
static_cast<uint32_t>(rule.action())));
}
}
// If no rules blocked then we should allow.
if (mAction == Action::eUnspecified) {
mAction = Action::eAllow;
}
const auto& requestToken = aResponse.request_token();
mRequestToken.Assign(requestToken.data(), requestToken.size());
}
ContentAnalysisResponse::ContentAnalysisResponse(
Action aAction, const nsACString& aRequestToken,
const nsACString& aUserActionId)
: mAction(aAction),
mRequestToken(aRequestToken),
mUserActionId(aUserActionId),
mIsSyntheticResponse(true) {
MOZ_ASSERT(mAction != Action::eUnspecified);
}
/* static */
already_AddRefed<ContentAnalysisResponse> ContentAnalysisResponse::FromProtobuf(
content_analysis::sdk::ContentAnalysisResponse&& aResponse,
const nsCString& aUserActionId) {
auto ret = RefPtr<ContentAnalysisResponse>(
new ContentAnalysisResponse(std::move(aResponse), aUserActionId));
if (ret->mAction == Action::eUnspecified) {
return nullptr;
}
return ret.forget();
}
NS_IMETHODIMP
ContentAnalysisResponse::GetRequestToken(nsACString& aRequestToken) {
aRequestToken = mRequestToken;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisResponse::GetUserActionId(nsACString& aUserActionId) {
aUserActionId = mUserActionId;
return NS_OK;
}
static void LogResponse(
content_analysis::sdk::ContentAnalysisResponse* aPbResponse) {
if (!static_cast<LogModule*>(gContentAnalysisLog)
->ShouldLog(LogLevel::Debug)) {
return;
}
std::stringstream ss;
ss << "ContentAnalysisResponse:"
<< "\n";
#define ADD_FIELD(PBUF, NAME, FUNC) \
ss << " " << (NAME) << ": "; \
if ((PBUF)->has_##FUNC()) \
ss << (PBUF)->FUNC() << "\n"; \
else \
ss << "<none>" \
<< "\n";
ADD_FIELD(aPbResponse, "Request Token", request_token);
uint32_t i = 0;
for (const auto& result : aPbResponse->results()) {
ss << " Result " << i << ":"
<< "\n";
ADD_FIELD(&result, " Status", status);
uint32_t j = 0;
for (const auto& rule : result.triggered_rules()) {
ss << " Rule " << j << ":"
<< "\n";
ADD_FIELD(&rule, " action", action);
++j;
}
++i;
}
#undef ADD_FIELD
LOGD("%s", ss.str().c_str());
}
static nsresult ConvertToProtobuf(
nsIContentAnalysisAcknowledgement* aIn, const nsACString& aRequestToken,
content_analysis::sdk::ContentAnalysisAcknowledgement* aOut) {
aOut->set_request_token(aRequestToken.Data(), aRequestToken.Length());
nsIContentAnalysisAcknowledgement::Result result;
nsresult rv = aIn->GetResult(&result);
NS_ENSURE_SUCCESS(rv, rv);
aOut->set_status(
static_cast<content_analysis::sdk::ContentAnalysisAcknowledgement_Status>(
result));
nsIContentAnalysisAcknowledgement::FinalAction finalAction;
rv = aIn->GetFinalAction(&finalAction);
NS_ENSURE_SUCCESS(rv, rv);
aOut->set_final_action(
static_cast<
content_analysis::sdk::ContentAnalysisAcknowledgement_FinalAction>(
finalAction));
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisResponse::GetAction(Action* aAction) {
*aAction = mAction;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisResponse::GetCancelError(CancelError* aCancelError) {
*aCancelError = mCancelError;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisResponse::GetIsCachedResponse(bool* aIsCachedResponse) {
*aIsCachedResponse = mIsCachedResponse;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisResponse::GetIsSyntheticResponse(bool* aIsSyntheticResponse) {
*aIsSyntheticResponse = mIsSyntheticResponse;
return NS_OK;
}
static void LogAcknowledgement(
content_analysis::sdk::ContentAnalysisAcknowledgement* aPbAck) {
if (!static_cast<LogModule*>(gContentAnalysisLog)
->ShouldLog(LogLevel::Debug)) {
return;
}
std::stringstream ss;
ss << "ContentAnalysisAcknowledgement:"
<< "\n";
#define ADD_FIELD(PBUF, NAME, FUNC) \
ss << " " << (NAME) << ": "; \
if ((PBUF)->has_##FUNC()) \
ss << (PBUF)->FUNC() << "\n"; \
else \
ss << "<none>" \
<< "\n";
ADD_FIELD(aPbAck, "Request Token", request_token);
ADD_FIELD(aPbAck, "Status", status);
ADD_FIELD(aPbAck, "Final Action", final_action);
#undef ADD_FIELD
LOGD("%s", ss.str().c_str());
}
void ContentAnalysisResponse::SetOwner(ContentAnalysis* aOwner) {
mOwner = std::move(aOwner);
}
void ContentAnalysisResponse::SetCancelError(CancelError aCancelError) {
mCancelError = aCancelError;
}
void ContentAnalysisResponse::ResolveWarnAction(bool aAllowContent) {
MOZ_ASSERT(mAction == Action::eWarn);
mAction = aAllowContent ? Action::eAllow : Action::eBlock;
}
ContentAnalysisAcknowledgement::ContentAnalysisAcknowledgement(
Result aResult, FinalAction aFinalAction)
: mResult(aResult), mFinalAction(aFinalAction) {}
NS_IMETHODIMP
ContentAnalysisAcknowledgement::GetResult(Result* aResult) {
*aResult = mResult;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysisAcknowledgement::GetFinalAction(FinalAction* aFinalAction) {
*aFinalAction = mFinalAction;
return NS_OK;
}
namespace {
static bool ShouldAllowAction(
nsIContentAnalysisResponse::Action aResponseCode) {
return aResponseCode == nsIContentAnalysisResponse::Action::eAllow ||
aResponseCode == nsIContentAnalysisResponse::Action::eReportOnly ||
aResponseCode == nsIContentAnalysisResponse::Action::eWarn;
}
static DefaultResult GetDefaultResultFromPref(bool isTimeout) {
uint32_t value = isTimeout
? StaticPrefs::browser_contentanalysis_timeout_result()
: StaticPrefs::browser_contentanalysis_default_result();
if (value > static_cast<uint32_t>(DefaultResult::eLastValue)) {
LOGE(
"Invalid value for browser.contentanalysis.%s pref "
"value",
isTimeout ? "default_timeout_result" : "default_result");
return DefaultResult::eBlock;
}
return static_cast<DefaultResult>(value);
}
} // namespace
NS_IMETHODIMP ContentAnalysisResponse::GetShouldAllowContent(
bool* aShouldAllowContent) {
*aShouldAllowContent = ShouldAllowAction(mAction);
return NS_OK;
}
NS_IMETHODIMP ContentAnalysisActionResult::GetShouldAllowContent(
bool* aShouldAllowContent) {
*aShouldAllowContent = ShouldAllowAction(mAction);
return NS_OK;
}
NS_IMETHODIMP ContentAnalysisNoResult::GetShouldAllowContent(
bool* aShouldAllowContent) {
// Make sure to use the non-timeout pref here, because timeouts won't
// go through this code path.
if (GetDefaultResultFromPref(/* isTimeout */ false) ==
DefaultResult::eAllow) {
*aShouldAllowContent =
mValue != NoContentAnalysisResult::DENY_DUE_TO_CANCELED;
} else {
// Note that we allow content if we're unable to get it (for example, if
// there's clipboard content that is not text or file)
*aShouldAllowContent =
mValue ==
NoContentAnalysisResult::ALLOW_DUE_TO_CONTENT_ANALYSIS_NOT_ACTIVE ||
mValue == NoContentAnalysisResult::
ALLOW_DUE_TO_CONTEXT_EXEMPT_FROM_CONTENT_ANALYSIS ||
mValue == NoContentAnalysisResult::ALLOW_DUE_TO_SAME_TAB_SOURCE ||
mValue == NoContentAnalysisResult::ALLOW_DUE_TO_COULD_NOT_GET_DATA;
}
return NS_OK;
}
void ContentAnalysis::EnsureParsedUrlFilters() {
MOZ_ASSERT(NS_IsMainThread());
if (mParsedUrlLists) {
return;
}
mParsedUrlLists = true;
nsAutoCString allowList;
MOZ_ALWAYS_SUCCEEDS(Preferences::GetCString(kAllowUrlPref, allowList));
for (const nsACString& regexSubstr : allowList.Split(u' ')) {
if (!regexSubstr.IsEmpty()) {
auto flatStr = PromiseFlatCString(regexSubstr);
const char* regex = flatStr.get();
LOGD("CA will allow URLs that match %s", regex);
mAllowUrlList.push_back(std::regex(regex));
}
}
nsAutoCString denyList;
MOZ_ALWAYS_SUCCEEDS(Preferences::GetCString(kDenyUrlPref, denyList));
for (const nsACString& regexSubstr : denyList.Split(u' ')) {
if (!regexSubstr.IsEmpty()) {
auto flatStr = PromiseFlatCString(regexSubstr);
const char* regex = flatStr.get();
LOGD("CA will block URLs that match %s", regex);
mDenyUrlList.push_back(std::regex(regex));
}
}
}
ContentAnalysis::UrlFilterResult ContentAnalysis::FilterByUrlLists(
nsIContentAnalysisRequest* aRequest, nsIURI* aUri) {
EnsureParsedUrlFilters();
nsCString urlString;
nsresult rv = aUri->GetSpec(urlString);
NS_ENSURE_SUCCESS(rv, UrlFilterResult::eDeny);
MOZ_ASSERT(!urlString.IsEmpty());
LOGD("Content Analysis checking URL against URL filter list | URL: %s",
urlString.get());
std::string url = urlString.BeginReading();
size_t count = 0;
for (const auto& denyFilter : mDenyUrlList) {
if (std::regex_match(url, denyFilter)) {
LOGD("Denying CA request : Deny filter %zu matched url %s", count,
url.c_str());
return UrlFilterResult::eDeny;
}
++count;
}
count = 0;
UrlFilterResult result = UrlFilterResult::eCheck;
for (const auto& allowFilter : mAllowUrlList) {
if (std::regex_match(url, allowFilter)) {
LOGD("CA request : Allow filter %zu matched %s", count, url.c_str());
result = UrlFilterResult::eAllow;
break;
}
++count;
}
// The rest only applies to download resources.
nsIContentAnalysisRequest::AnalysisType analysisType;
MOZ_ALWAYS_SUCCEEDS(aRequest->GetAnalysisType(&analysisType));
if (analysisType != ContentAnalysisRequest::AnalysisType::eFileDownloaded) {
MOZ_ASSERT(result == UrlFilterResult::eCheck ||
result == UrlFilterResult::eAllow);
LOGD("CA request filter result: %s",
result == UrlFilterResult::eCheck ? "check" : "allow");
return result;
}
nsTArray<RefPtr<nsIClientDownloadResource>> resources;
MOZ_ALWAYS_SUCCEEDS(aRequest->GetResources(resources));
for (size_t resourceIdx = 0; resourceIdx < resources.Length();
/* noop */) {
auto& resource = resources[resourceIdx];
nsAutoString nsUrl;
MOZ_ALWAYS_SUCCEEDS(resource->GetUrl(nsUrl));
std::string url = NS_ConvertUTF16toUTF8(nsUrl).get();
count = 0;
for (auto& denyFilter : mDenyUrlList) {
if (std::regex_match(url, denyFilter)) {
LOGD(
"Denying CA request : Deny filter %zu matched download resource "
"at url %s",
count, url.c_str());
return UrlFilterResult::eDeny;
}
++count;
}
count = 0;
bool removed = false;
for (auto& allowFilter : mAllowUrlList) {
if (std::regex_match(url, allowFilter)) {
LOGD(
"CA request : Allow filter %zu matched download resource "
"at url %s",
count, url.c_str());
resources.RemoveElementAt(resourceIdx);
removed = true;
break;
}
++count;
}
if (!removed) {
++resourceIdx;
}
}
// Check unless all were allowed.
return resources.Length() ? UrlFilterResult::eCheck : UrlFilterResult::eAllow;
}
NS_IMPL_ISUPPORTS(ContentAnalysisRequest, nsIContentAnalysisRequest);
NS_IMPL_ISUPPORTS(ContentAnalysisResponse, nsIContentAnalysisResponse,
nsIContentAnalysisResult, nsIClassInfo);
NS_IMPL_CI_INTERFACE_GETTER(ContentAnalysisResponse, nsIContentAnalysisResponse,
nsIContentAnalysisResult);
NS_IMPL_THREADSAFE_CI(ContentAnalysisResponse);
NS_IMPL_ISUPPORTS(ContentAnalysisActionResult, nsIContentAnalysisResult);
NS_IMPL_ISUPPORTS(ContentAnalysisNoResult, nsIContentAnalysisResult);
NS_IMPL_ISUPPORTS(ContentAnalysisAcknowledgement,
nsIContentAnalysisAcknowledgement);
NS_IMPL_ISUPPORTS(ContentAnalysisCallback, nsIContentAnalysisCallback);
NS_IMPL_ISUPPORTS(ContentAnalysisDiagnosticInfo,
nsIContentAnalysisDiagnosticInfo);
NS_IMPL_ISUPPORTS(ContentAnalysis, nsIContentAnalysis, nsIObserver,
ContentAnalysis);
ContentAnalysis::ContentAnalysis()
: mThreadPool(new nsThreadPool()),
mRequestTokenToBasicRequestInfoMap(
"ContentAnalysis::mRequestTokenToBasicRequestInfoMap"),
mCaClientPromise(
new ClientPromise::Private("ContentAnalysis::ContentAnalysis")),
mSetByEnterprise(false) {
// Limit one per process
[[maybe_unused]] static bool sCreated = false;
MOZ_ASSERT(!sCreated);
sCreated = true;
MOZ_ALWAYS_SUCCEEDS(
mThreadPool->SetName(nsAutoCString("ContentAnalysisAgentIO")));
unsigned long threadLimit =
std::min(static_cast<unsigned long>(
StaticPrefs::browser_contentanalysis_max_connections()),
kMaxContentAnalysisAgentThreads);
MOZ_ALWAYS_SUCCEEDS(mThreadPool->SetThreadLimit(threadLimit));
// Update thread limit if the pref changes, for testing (otherwise it is
// locked). We cannot use RegisterCallbackAndCall since the callback needs
// to get the service that we are currently constructing.
Preferences::RegisterCallback(
[](const char* aPref, void*) {
auto self = GetContentAnalysisFromService();
if (!self) {
return;
}
unsigned long threadLimit = std::min(
static_cast<unsigned long>(
StaticPrefs::browser_contentanalysis_max_connections()),
kMaxContentAnalysisAgentThreads);
MOZ_ALWAYS_SUCCEEDS(self->mThreadPool->SetThreadLimit(threadLimit));
},
nsDependentCString(
StaticPrefs::GetPrefName_browser_contentanalysis_max_connections()));
MOZ_ALWAYS_SUCCEEDS(
mThreadPool->SetIdleThreadLimit(kMaxIdleContentAnalysisAgentThreads));
MOZ_ALWAYS_SUCCEEDS(mThreadPool->SetIdleThreadGraceTimeout(
kIdleContentAnalysisAgentTimeoutMs));
MOZ_ALWAYS_SUCCEEDS(mThreadPool->SetIdleThreadMaximumTimeout(
kMaxIdleContentAnalysisAgentTimeoutMs));
nsCOMPtr<nsIObserverService> obsServ =
mozilla::services::GetObserverService();
obsServ->AddObserver(this, "xpcom-shutdown-threads", false);
}
ContentAnalysis::~ContentAnalysis() {
LOGD("ContentAnalysis::~ContentAnalysis");
AssertIsOnMainThread();
MOZ_ASSERT(mUserActionMap.IsEmpty());
MOZ_ASSERT(!mThreadPool);
DebugOnly lock = mIsShutDown.Lock();
MOZ_ASSERT(*lock.inspect());
}
NS_IMETHODIMP
ContentAnalysis::Observe(nsISupports* subject, const char* topic,
const char16_t* data) {
AssertIsOnMainThread();
MOZ_ASSERT(nsCString("xpcom-shutdown-threads") == topic);
LOGD("Content Analysis received xpcom-shutdown-threads");
Close();
return NS_OK;
}
void ContentAnalysis::Close() {
AssertIsOnMainThread();
{
// Make sure that we don't try to reconnect to the agent.
auto lock = mIsShutDown.Lock();
if (*lock) {
// was previously called
return;
}
*lock = true;
}
nsCOMPtr<nsIObserverService> obsServ =
mozilla::services::GetObserverService();
obsServ->RemoveObserver(this, "xpcom-shutdown-threads");
// Reject the promise to avoid assertions when it gets destroyed
// Note that if the promise has already been resolved or rejected this is a
// noop
mCaClientPromise->Reject(NS_ERROR_ILLEGAL_DURING_SHUTDOWN, __func__);
// In case the promise _was_ resolved before, create a new one and reject
// that.
mCaClientPromise =
new ClientPromise::Private("ContentAnalysis:ShutdownReject");
mCaClientPromise->Reject(NS_ERROR_ILLEGAL_DURING_SHUTDOWN, __func__);
// The userActionMap must be cleared before the object is destroyed.
mUserActionMap.Clear();
mThreadPool->ShutdownWithTimeout(kShutdownThreadpoolTimeoutMs);
mThreadPool = nullptr;
LOGD("Content Analysis service is closed");
}
bool ContentAnalysis::IsShutDown() {
auto lock = mIsShutDown.ConstLock();
return *lock;
}
NS_IMETHODIMP ContentAnalysis::ForceRecreateClientForTest() {
return CreateClientIfNecessary(/* aForceCreate */ true);
}
nsresult ContentAnalysis::CreateClientIfNecessary(
bool aForceCreate /* = false */) {
AssertIsOnMainThread();
if (IsShutDown()) {
return NS_OK;
}
nsCString pipePathName;
nsresult rv = Preferences::GetCString(kPipePathNamePref, pipePathName);
if (NS_WARN_IF(NS_FAILED(rv))) {
mCaClientPromise->Reject(rv, __func__);
return rv;
}
if (mHaveResolvedClientPromise && !aForceCreate) {
return NS_OK;
}
// mCreatingClient is only accessed on the main thread
if (mCreatingClient) {
return NS_OK;
}
mCreatingClient = true;
mHaveResolvedClientPromise = false;
// Reject the promise to avoid assertions when it gets destroyed
// Note that if the promise has already been resolved or rejected this is a
// noop
mCaClientPromise->Reject(NS_ERROR_FAILURE, __func__);
mCaClientPromise =
new ClientPromise::Private("ContentAnalysis::ContentAnalysis");
bool isPerUser = StaticPrefs::browser_contentanalysis_is_per_user();
nsString clientSignature;
// It's OK if this fails, we will default to the empty string
Preferences::GetString(kClientSignature, clientSignature);
RecordConnectionSettingsTelemetry(clientSignature);
LOGD("Dispatching background task to create Content Analysis client");
glean::content_analysis::connection_attempt.Add();
if (aForceCreate) {
// indicates this is a retry attempt
glean::content_analysis::connection_attempt_retry.Add();
}
rv = NS_DispatchBackgroundTask(NS_NewCancelableRunnableFunction(
"ContentAnalysis::CreateContentAnalysisClient",
[owner = RefPtr{this}, pipePathName = std::move(pipePathName),
clientSignature = std::move(clientSignature), isPerUser]() mutable {
owner->CreateContentAnalysisClient(
std::move(pipePathName), std::move(clientSignature), isPerUser);
}));
if (NS_WARN_IF(NS_FAILED(rv))) {
glean::content_analysis::connection_failure
.Get(nsCString{SafeGetStaticErrorName(rv)})
.Add();
mCaClientPromise->Reject(rv, __func__);
return rv;
}
return NS_OK;
}
void ContentAnalysis::RecordConnectionSettingsTelemetry(
const nsString& clientSignature) {
AssertIsOnMainThread();
{
nsCString agentName;
Preferences::GetCString(kAgentNamePref, agentName);
glean::content_analysis::agent_name.Set(agentName);
}
AutoTArray<nsCString, 1> interceptionPointsOff;
for (const char* interceptionPointPrefName : kInterceptionPointPrefNames) {
bool interceptionPointPrefValue = false;
Preferences::GetBool(interceptionPointPrefName,
&interceptionPointPrefValue);
if (!interceptionPointPrefValue) {
interceptionPointsOff.AppendElement(interceptionPointPrefName);
}
}
if (!interceptionPointsOff.IsEmpty()) {
glean::content_analysis::interception_points_turned_off.Set(
interceptionPointsOff);
}
glean::content_analysis::show_blocked_result.Set(
StaticPrefs::browser_contentanalysis_show_blocked_result());
glean::content_analysis::default_result.Set(
StaticPrefs::browser_contentanalysis_default_result());
glean::content_analysis::timeout_result.Set(
StaticPrefs::browser_contentanalysis_timeout_result());
if (!clientSignature.IsEmpty()) {
glean::content_analysis::client_signature.Set(
NS_ConvertUTF16toUTF8(clientSignature));
}
glean::content_analysis::bypass_for_same_tab_operations.Set(
StaticPrefs::browser_contentanalysis_bypass_for_same_tab_operations());
{
nsCString allowUrlRegexList;
Preferences::GetCString(kAllowUrlPref, allowUrlRegexList);
// Unfortunately because of the way enterprise policies set and lock prefs,
// we can't check if the value is different than the default in
// StaticPrefList.yaml, and instead we have to duplicate that value here. At
// least we have a test around this so we can update this value if the
// default changes.
const char* defaultAllowUrlRegexList = "^about:(?!blank|srcdoc).*";
glean::content_analysis::allow_url_regex_list_set.Set(
!allowUrlRegexList.Equals(defaultAllowUrlRegexList));
}
{
nsCString denyUrlRegexList;
Preferences::GetCString(kDenyUrlPref, denyUrlRegexList);
glean::content_analysis::deny_url_regex_list_set.Set(
!denyUrlRegexList.IsEmpty());
}
}
NS_IMETHODIMP
ContentAnalysis::GetIsActive(bool* aIsActive) {
*aIsActive = false;
if (!StaticPrefs::browser_contentanalysis_enabled()) {
LOGD("Local DLP Content Analysis is not enabled");
return NS_OK;
}
// Accessing mSetByEnterprise and non-static prefs
// so need to be on the main thread
AssertIsOnMainThread();
// gAllowContentAnalysisArgPresent is only set in the parent process
MOZ_ASSERT(XRE_IsParentProcess());
if (!gAllowContentAnalysisArgPresent && !mSetByEnterprise) {
LOGE(
"The content analysis pref is enabled but not by an enterprise "
"policy and -allow-content-analysis was not present on the "
"command-line. Content Analysis will not be active.");
return NS_OK;
}
*aIsActive = true;
LOGD("Local DLP Content Analysis is enabled");
return CreateClientIfNecessary();
}
NS_IMETHODIMP
ContentAnalysis::GetMightBeActive(bool* aMightBeActive) {
*aMightBeActive = nsIContentAnalysis::MightBeActive();
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysis::GetIsSetByEnterprisePolicy(bool* aSetByEnterprise) {
*aSetByEnterprise = mSetByEnterprise;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysis::SetIsSetByEnterprisePolicy(bool aSetByEnterprise) {
mSetByEnterprise = aSetByEnterprise;
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysis::TestOnlySetCACmdLineArg(bool aVal) {
#ifdef ENABLE_TESTS
gAllowContentAnalysisArgPresent = aVal;
return NS_OK;
#else
LOGE("ContentAnalysis::TestOnlySetCACmdLineArg is test-only");
return NS_ERROR_UNEXPECTED;
#endif
}
Maybe<nsIContentAnalysisResponse::Action>
ContentAnalysis::CachedClipboardResponse::GetCachedResponse(
nsIURI* aURI, int32_t aClipboardSequenceNumber) {
MOZ_ASSERT(NS_IsMainThread(),
"Expecting main thread access only to avoid synchronization");
if (Some(aClipboardSequenceNumber) != mClipboardSequenceNumber) {
LOGD("CachedClipboardResponse seqno does not match cached value");
return Nothing();
}
for (const auto& entry : mData) {
bool uriEquals = false;
// URI will not be set for some chrome contexts
if ((!aURI && !entry.first) ||
(aURI && NS_SUCCEEDED(aURI->Equals(entry.first, &uriEquals)) &&
uriEquals)) {
LOGD("CachedClipboardResponse match");
return Some(entry.second);
}
}
LOGD("CachedClipboardResponse did not match any cached URI");
return Nothing();
}
void ContentAnalysis::CachedClipboardResponse::SetCachedResponse(
const nsCOMPtr<nsIURI>& aURI, int32_t aClipboardSequenceNumber,
nsIContentAnalysisResponse::Action aAction) {
MOZ_ASSERT(NS_IsMainThread(),
"Expecting main thread access only to avoid synchronization");
if (mClipboardSequenceNumber != Some(aClipboardSequenceNumber)) {
LOGD("CachedClipboardResponse caching new clipboard seqno");
mData.Clear();
mClipboardSequenceNumber = Some(aClipboardSequenceNumber);
} else {
LOGD(
"CachedClipboardResponse caching new URI for existing cached clipboard "
"seqno");
}
// Update the cached action for this URI if it already exists in the cache,
// otherwise add a new cache entry for this URI.
for (auto& entry : mData) {
bool uriEquals = false;
// URI will not be set for some chrome contexts
if ((!aURI && !entry.first) ||
(aURI && NS_SUCCEEDED(aURI->Equals(entry.first, &uriEquals)) &&
uriEquals)) {
entry.second = aAction;
return;
}
}
mData.AppendElement(std::make_pair(aURI, aAction));
}
NS_IMETHODIMP ContentAnalysis::SetCachedResponse(
nsIURI* aURI, int32_t aClipboardSequenceNumber,
nsIContentAnalysisResponse::Action aAction) {
mCachedClipboardResponse.SetCachedResponse(aURI, aClipboardSequenceNumber,
aAction);
return NS_OK;
}
NS_IMETHODIMP ContentAnalysis::GetCachedResponse(
nsIURI* aURI, int32_t aClipboardSequenceNumber,
nsIContentAnalysisResponse::Action* aAction, bool* aIsValid) {
auto action = mCachedClipboardResponse.GetCachedResponse(
aURI, aClipboardSequenceNumber);
*aIsValid = action.isSome();
if (action.isSome()) {
*aAction = *action;
}
return NS_OK;
}
void ContentAnalysis::CancelWithError(nsCString&& aUserActionId,
nsresult aResult) {
MOZ_ASSERT(!aUserActionId.IsEmpty());
if (!NS_IsMainThread()) {
NS_DispatchToMainThread(NS_NewCancelableRunnableFunction(
"CancelWithError",
[aUserActionId = std::move(aUserActionId), aResult]() mutable {
auto self = GetContentAnalysisFromService();
if (!self) {
// May be shutting down
return;
}
self->CancelWithError(std::move(aUserActionId), aResult);
}));
return;
}
AssertIsOnMainThread();
LOGD("CancelWithError | aUserActionId: %s | aResult: %s\n",
aUserActionId.get(), SafeGetStaticErrorName(aResult));
AutoTArray<nsCString, 1> tokens;
RefPtr<nsIContentAnalysisCallback> callback;
bool autoAcknowledge;
if (auto maybeUserActionData = mUserActionMap.Lookup(aUserActionId)) {
// We are cancelling all existing requests for this user action.
tokens =
ToTArray<AutoTArray<nsCString, 1>>(maybeUserActionData->mRequestTokens);
callback = maybeUserActionData->mCallback;
autoAcknowledge = maybeUserActionData->mAutoAcknowledge;
} else {
LOGD(
"ContentAnalysis::CancelWithError user action not found -- already "
"responded | userActionId: %s",
aUserActionId.get());
auto userActionIdToCanceledResponseMap =
mUserActionIdToCanceledResponseMap.Lock();
if (auto entry = userActionIdToCanceledResponseMap->Lookup(aUserActionId)) {
entry->mNumExpectedResponses--;
if (!entry->mNumExpectedResponses) {
entry.Remove();
}
}
return;
}
if (tokens.IsEmpty()) {
// There are two cases where this happens.
// (1) This Cancel was for the last request in the user action. We don't
// have any other tokens to cancel and we have nothing to tell the agent to
// cancel. Note that this case is only possible if this cancel call is
// due to a negative verdict from the agent, and that handler will remove
// our userActionId from mUserActionMap, so there is nothing left to do.
// (2) We canceled before the final request list was formed. We still
// need to call the callback -- we do this when the final request list
// is complete.
MOZ_ASSERT(
aResult == NS_ERROR_ABORT,
"Token list can only be empty when canceling all remaining requests");
LOGD(
"ContentAnalysis::CancelWithError user action not found -- either was "
"after last response or before first request was submitted | "
"userActionId: %s",
aUserActionId.get());
RemoveFromUserActionMap(std::move(aUserActionId));
return;
}
LOGD(
"ContentAnalysis::CancelWithError cancelling user action: %s with error: "
"%s",
aUserActionId.get(), SafeGetStaticErrorName(aResult));
bool isShutdown = aResult == NS_ERROR_ILLEGAL_DURING_SHUTDOWN;
bool isCancel = aResult == NS_ERROR_ABORT;
bool isTimeout = aResult == NS_ERROR_DOM_TIMEOUT_ERR;
// Propagate shutdown error to the callback as that same error. All other
// cases use the default response, except user cancel, which always uses
// cancel response.
// Note that, for shutdown errors, if we returned a default warn response
// (as opposed to some other value -- we currently return the error),
// the result would be a shutdown hang while the dialog waited for a user
// response (bug 1912245).
nsIContentAnalysisResponse::Action action =
nsIContentAnalysisResponse::Action::eCanceled;
if (!isShutdown && !isCancel) {
DefaultResult defaultResponse = GetDefaultResultFromPref(isTimeout);
switch (defaultResponse) {
case DefaultResult::eAllow:
action = nsIContentAnalysisResponse::Action::eAllow;
break;
case DefaultResult::eWarn:
action = nsIContentAnalysisResponse::Action::eWarn;
break;
case DefaultResult::eBlock:
// eBlock would show a block dialog but eCanceled will not.
action = nsIContentAnalysisResponse::Action::eCanceled;
break;
default:
MOZ_ASSERT(false);
action = nsIContentAnalysisResponse::Action::eCanceled;
}
}
nsIContentAnalysisResponse::CancelError cancelError;
switch (aResult) {
case NS_ERROR_NOT_AVAILABLE:
case NS_ERROR_CONNECTION_REFUSED:
cancelError = nsIContentAnalysisResponse::CancelError::eNoAgent;
break;
case NS_ERROR_INVALID_SIGNATURE:
cancelError =
nsIContentAnalysisResponse::CancelError::eInvalidAgentSignature;
break;
case NS_ERROR_WONT_HANDLE_CONTENT:
case NS_ERROR_ABORT:
cancelError = nsIContentAnalysisResponse::CancelError::
eOtherRequestInGroupCancelled;
break;
case NS_ERROR_ILLEGAL_DURING_SHUTDOWN:
cancelError = nsIContentAnalysisResponse::CancelError::eShutdown;
break;
case NS_ERROR_DOM_TIMEOUT_ERR:
cancelError = nsIContentAnalysisResponse::CancelError::eTimeout;
break;
default:
cancelError = nsIContentAnalysisResponse::CancelError::eErrorOther;
break;
}
bool calledError = false;
for (const auto& token : tokens) {
auto response =
MakeRefPtr<ContentAnalysisResponse>(action, token, aUserActionId);
response->SetCancelError(cancelError);
// Alert the UI and (if action is not warn) the callback. We aren't
// handling an actual response so we have nothing to acknowledge.
NotifyResponseObservers(response, nsCString(aUserActionId), autoAcknowledge,
isTimeout);
if (action != nsIContentAnalysisResponse::Action::eWarn) {
if (callback) {
if (isShutdown) {
// One Error response call is sufficient to complete the
// MultipartRequestCallback.
if (!calledError) {
callback->Error(aResult);
calledError = true;
}
} else {
callback->ContentResult(response);
}
}
}
}
if (action == nsIContentAnalysisResponse::Action::eWarn) {
// A default warn response will handle the rest after the user chooses
// a result.
return;
}
RemoveFromUserActionMap(nsCString(aUserActionId));
// NS_ERROR_WONT_HANDLE_CONTENT and NS_ERROR_CONNECTION_REFUSED mean the
// request was never sent to the agent, so we don't cancel it.
if (aResult != NS_ERROR_WONT_HANDLE_CONTENT &&
aResult != NS_ERROR_CONNECTION_REFUSED) {
auto userActionIdToCanceledResponseMap =
mUserActionIdToCanceledResponseMap.Lock();
userActionIdToCanceledResponseMap->InsertOrUpdate(
aUserActionId,
CanceledResponse{ConvertResult(action), tokens.Length()});
} else {
LOGD("CancelWithError cancelling unsubmitted request with error %s.",
SafeGetStaticErrorName(aResult));
return;
}
// Re-get service in case the registered service is mocked for testing.
nsCOMPtr<nsIContentAnalysis> contentAnalysis =
mozilla::components::nsIContentAnalysis::Service();
if (contentAnalysis) {
contentAnalysis->SendCancelToAgent(aUserActionId);
} else {
LOGD(
"Content Analysis Service has been shut down. Cancel will not be "
"sent to agent.");
}
}
NS_IMETHODIMP ContentAnalysis::SendCancelToAgent(
const nsACString& aUserActionId) {
CallClientWithRetry<std::nullptr_t>(
__func__,
[userActionId = nsCString(aUserActionId)](
std::shared_ptr<content_analysis::sdk::Client> client) mutable
-> Result<std::nullptr_t, nsresult> {
MOZ_ASSERT(!NS_IsMainThread());
auto owner = GetContentAnalysisFromService();
if (!owner) {
// May be shutting down
return nullptr;
}
content_analysis::sdk::ContentAnalysisCancelRequests cancelRequest;
cancelRequest.set_user_action_id(userActionId.get(),
userActionId.Length());
int err = client->CancelRequests(cancelRequest);
if (err != 0) {
LOGE(
"SendCancelToAgent got error %d for "
"user_action_id: %s",
err, userActionId.get());
return Err(NS_ERROR_FAILURE);
}
LOGD(
"SendCancelToAgent successfully sent CancelRequests to "
"agent for user_action_id: %s",
userActionId.get());
return nullptr;
})
->Then(
GetCurrentSerialEventTarget(), __func__, []() { /* nothing to do */ },
[](nsresult rv) {
LOGE("SendCancelToAgent failed to get the client with error %s",
SafeGetStaticErrorName(rv));
});
return NS_OK;
}
RefPtr<ContentAnalysis> ContentAnalysis::GetContentAnalysisFromService() {
RefPtr<ContentAnalysis> contentAnalysisService =
mozilla::components::nsIContentAnalysis::Service();
return contentAnalysisService;
}
static bool ShouldCheckReason(nsIContentAnalysisRequest::Reason aReason) {
switch (aReason) {
case nsIContentAnalysisRequest::Reason::eFilePickerDialog:
return mozilla::StaticPrefs::
browser_contentanalysis_interception_point_file_upload_enabled();
case nsIContentAnalysisRequest::Reason::eClipboardPaste:
return mozilla::StaticPrefs::
browser_contentanalysis_interception_point_clipboard_enabled();
case nsIContentAnalysisRequest::Reason::ePrintPreviewPrint:
case nsIContentAnalysisRequest::Reason::eSystemDialogPrint:
return mozilla::StaticPrefs::
browser_contentanalysis_interception_point_print_enabled();
case nsIContentAnalysisRequest::Reason::eDragAndDrop:
return mozilla::StaticPrefs::
browser_contentanalysis_interception_point_drag_and_drop_enabled();
case nsIContentAnalysisRequest::Reason::eNormalDownload:
case nsIContentAnalysisRequest::Reason::eSaveAsDownload:
return mozilla::StaticPrefs::
browser_contentanalysis_interception_point_download_enabled();
default:
MOZ_ASSERT_UNREACHABLE("Unrecognized content analysis request reason");
return false; // don't try to check it
}
}
template <typename T, typename U>
RefPtr<MozPromise<T, nsresult, true>> ContentAnalysis::CallClientWithRetry(
StaticString aMethodName, U&& aClientCallFunc) {
AssertIsOnMainThread();
auto promise =
MakeRefPtr<typename MozPromise<T, nsresult, true>::Private>(aMethodName);
auto reconnectAndRetry = [aClientCallFunc, aMethodName,
promise](nsresult rv) {
AssertIsOnMainThread();
LOGD("Failed to get client - trying to reconnect: %s",
SafeGetStaticErrorName(rv));
RefPtr<ContentAnalysis> owner = GetContentAnalysisFromService();
if (!owner) {
// May be shutting down
promise->Reject(NS_ERROR_ILLEGAL_DURING_SHUTDOWN, aMethodName);
return;
}
// try to reconnect
rv = owner->CreateClientIfNecessary(/* aForceCreate */ true);
if (NS_FAILED(rv)) {
LOGD("Failed to reconnect to client: %s", SafeGetStaticErrorName(rv));
owner->mCaClientPromise->Reject(rv, aMethodName);
promise->Reject(rv, aMethodName);
return;
}
owner->mCaClientPromise->Then(
GetCurrentSerialEventTarget(), aMethodName,
[aMethodName, promise, clientCallFunc = std::move(aClientCallFunc)](
std::shared_ptr<content_analysis::sdk::Client> client) mutable {
auto contentAnalysis = GetContentAnalysisFromService();
if (!contentAnalysis) {
promise->Reject(NS_ERROR_ILLEGAL_DURING_SHUTDOWN, aMethodName);
return;
}
nsresult rv = contentAnalysis->mThreadPool->Dispatch(
NS_NewCancelableRunnableFunction(
aMethodName, [aMethodName, promise,
clientCallFunc = std::move(clientCallFunc),
client = std::move(client)]() mutable {
auto result = clientCallFunc(client);
if (result.isOk()) {
promise->Resolve(result.unwrap(), aMethodName);
} else {
promise->Reject(result.unwrapErr(), aMethodName);
}
}));
if (NS_FAILED(rv)) {
LOGE(
"Failed to launch background task in second call for %s, "
"error=%s",
aMethodName.get(), SafeGetStaticErrorName(rv));
promise->Reject(rv, aMethodName);
}
},
[aMethodName, promise](nsresult rv) {
LOGE("Failed to get client again for %s, error=%s", aMethodName.get(),
SafeGetStaticErrorName(rv));
promise->Reject(rv, aMethodName);
});
};
mCaClientPromise->Then(
GetCurrentSerialEventTarget(), aMethodName,
[aMethodName, promise, aClientCallFunc, reconnectAndRetry](
std::shared_ptr<content_analysis::sdk::Client> client) mutable {
auto contentAnalysis = GetContentAnalysisFromService();
if (!contentAnalysis) {
promise->Reject(NS_ERROR_ILLEGAL_DURING_SHUTDOWN, aMethodName);
return;
}
nsresult rv = contentAnalysis->mThreadPool->Dispatch(
NS_NewCancelableRunnableFunction(
aMethodName, [aMethodName, promise, aClientCallFunc,
reconnectAndRetry = std::move(reconnectAndRetry),
client = std::move(client)]() mutable {
auto result = aClientCallFunc(client);
if (result.isOk()) {
promise->Resolve(result.unwrap(), aMethodName);
return;
}
nsresult rv = result.unwrapErr();
NS_DispatchToMainThread(NS_NewCancelableRunnableFunction(
"reconnect to Content Analysis client",
[rv, reconnectAndRetry = std::move(reconnectAndRetry)]() {
reconnectAndRetry(rv);
}));
}));
if (NS_FAILED(rv)) {
LOGE(
"Failed to launch background task in first call for %s, error=%s",
aMethodName.get(), SafeGetStaticErrorName(rv));
promise->Reject(rv, aMethodName);
}
},
[reconnectAndRetry](nsresult rv) mutable { reconnectAndRetry(rv); });
return promise.forget();
}
nsresult ContentAnalysis::RunAnalyzeRequestTask(
const RefPtr<nsIContentAnalysisRequest>& aRequest, bool aAutoAcknowledge,
const RefPtr<nsIContentAnalysisCallback>& aCallback) {
AssertIsOnMainThread();
nsresult rv = NS_ERROR_FAILURE;
// Set up the scope exit before checking the return
// value so we will call Error() if this call failed.
auto callbackCopy = aCallback;
auto se = MakeScopeExit([&]() {
if (!NS_SUCCEEDED(rv)) {
LOGE("RunAnalyzeRequestTask failed");
callbackCopy->Error(rv);
}
});
nsCString requestToken;
MOZ_ALWAYS_SUCCEEDS(aRequest->GetRequestToken(requestToken));
nsCString userActionId;
MOZ_ALWAYS_SUCCEEDS(aRequest->GetUserActionId(userActionId));
// We will need to submit the request to the agent.
content_analysis::sdk::ContentAnalysisRequest pbRequest;
rv = ConvertToProtobuf(aRequest, &pbRequest);
NS_ENSURE_SUCCESS(rv, rv);
LOGD("Issuing ContentAnalysisRequest for token %s", requestToken.get());
LogRequest(&pbRequest);
nsCOMPtr<nsIObserverService> obsServ =
mozilla::services::GetObserverService();
// Avoid serializing the string here if no one is observing this message
if (obsServ->HasObservers("dlp-request-sent-raw")) {
std::string requestString = pbRequest.SerializeAsString();
nsTArray<char16_t> requestArray;
requestArray.SetLength(requestString.size() + 1);
for (size_t i = 0; i < requestString.size(); ++i) {
// Since NotifyObservers() expects a null-terminated string,
// make sure none of these values are 0.
requestArray[i] = requestString[i] + 0xFF00;
}
requestArray[requestString.size()] = 0;
obsServ->NotifyObservers(static_cast<nsIContentAnalysis*>(this),
"dlp-request-sent-raw", requestArray.Elements());
}
bool ignoreCanceled;
MOZ_ALWAYS_SUCCEEDS(aRequest->GetTestOnlyIgnoreCanceledAndAlwaysSubmitToAgent(
&ignoreCanceled));
{
nsDependentCString analysisTypeStr(
content_analysis::sdk::AnalysisConnector_Name(
pbRequest.analysis_connector())
.c_str());
glean::content_analysis::request_sent_by_analysis_type.Get(analysisTypeStr)
.Add();
}
{
nsDependentCString reasonStr(
content_analysis::sdk::ContentAnalysisRequest_Reason_Name(
pbRequest.reason())
.c_str());
glean::content_analysis::request_sent_by_reason.Get(reasonStr).Add();
}
CallClientWithRetry<std::nullptr_t>(
__func__,
[userActionId, pbRequest = std::move(pbRequest), aAutoAcknowledge,
ignoreCanceled](
std::shared_ptr<content_analysis::sdk::Client> client) mutable {
MOZ_ASSERT(!NS_IsMainThread());
return DoAnalyzeRequest(std::move(userActionId), std::move(pbRequest),
aAutoAcknowledge, client, ignoreCanceled);
})
->Then(
GetMainThreadSerialEventTarget(), __func__, []() { /* do nothing */ },
[userActionId, requestToken](nsresult rv) mutable {
LOGD(
"RunAnalyzeRequestTask failed to get client a second time for "
"requestToken=%s, userActionId=%s",
requestToken.get(), userActionId.get());
RefPtr<ContentAnalysis> owner = GetContentAnalysisFromService();
if (!owner) {
// May be shutting down
return;
}
owner->CancelWithError(std::move(userActionId), rv);
});
return NS_OK;
}
Result<std::nullptr_t, nsresult> ContentAnalysis::DoAnalyzeRequest(
nsCString&& aUserActionId,
content_analysis::sdk::ContentAnalysisRequest&& aRequest,
bool aAutoAcknowledge,
const std::shared_ptr<content_analysis::sdk::Client>& aClient,
bool aTestOnlyIgnoreCanceled) {
MOZ_ASSERT(!NS_IsMainThread());
RefPtr<ContentAnalysis> owner =
ContentAnalysis::GetContentAnalysisFromService();
if (!owner) {
// May be shutting down
// Don't return an error because we don't want to retry
return nullptr;
}
if (aRequest.has_file_path() && !aRequest.file_path().empty() &&
(!aRequest.request_data().has_digest() ||
aRequest.request_data().digest().empty())) {
// Calculate the digest
nsCString digest;
nsCString fileCPath(aRequest.file_path().data(),
aRequest.file_path().length());
nsString filePath = NS_ConvertUTF8toUTF16(fileCPath);
nsresult rv = ContentAnalysisRequest::GetFileDigest(filePath, digest);
if (NS_FAILED(rv)) {
owner->CancelWithError(std::move(aUserActionId), rv);
// Don't return an error because we don't want to retry
return nullptr;
}
if (!digest.IsEmpty()) {
aRequest.mutable_request_data()->set_digest(digest.get());
}
}
bool actionWasCanceled = false;
if (!aTestOnlyIgnoreCanceled) {
auto userActionIdToCanceledResponseMap =
owner->mUserActionIdToCanceledResponseMap.Lock();
actionWasCanceled =
userActionIdToCanceledResponseMap->Contains(aUserActionId);
}
if (actionWasCanceled) {
LOGD(
"DoAnalyzeRequest | userAction: %s | requestToken: %s | was already "
"canceled",
aUserActionId.get(), aRequest.request_token().c_str());
return Err(NS_ERROR_WONT_HANDLE_CONTENT);
}
// Run request, then dispatch back to main thread to resolve
// aCallback
content_analysis::sdk::ContentAnalysisResponse pbResponse;
nsDependentCString analysisConnectorName(
content_analysis::sdk::AnalysisConnector_Name(
aRequest.analysis_connector())
.c_str());
auto timerId = glean::content_analysis::response_duration_by_analysis_type
.Get(analysisConnectorName)
.Start();
{
// Insert this into the map before calling Send() because another thread
// calling Send() may get a response before our Send() call finishes.
auto map = owner->mRequestTokenToBasicRequestInfoMap.Lock();
map->InsertOrUpdate(
nsCString(aRequest.request_token()),
BasicRequestInfo{aUserActionId, timerId,
std::move(analysisConnectorName), aAutoAcknowledge});
}
LOGD(
"DoAnalyzeRequest | userAction: %s | requestToken: %s | sending request "
"to agent",
aUserActionId.get(), aRequest.request_token().c_str());
int err = aClient->Send(aRequest, &pbResponse);
if (err != 0) {
LOGE("DoAnalyzeRequest got err=%d for request_token=%s, user_action_id=%s",
err, aRequest.request_token().c_str(), aUserActionId.get());
Maybe<BasicRequestInfo> entry;
{
auto map = owner->mRequestTokenToBasicRequestInfoMap.Lock();
entry = map->Extract(nsCString(aRequest.request_token()));
}
if (entry.isSome()) {
glean::content_analysis::response_duration_by_analysis_type
.Get(entry->mAnalysisTypeStr)
.Cancel(std::move(entry->mTimerId));
}
return Err(NS_ERROR_FAILURE);
}
HandleResponseFromAgent(std::move(pbResponse));
return nullptr;
}
void ContentAnalysis::HandleResponseFromAgent(
content_analysis::sdk::ContentAnalysisResponse&& aResponse) {
MOZ_ASSERT(!NS_IsMainThread());
NS_DispatchToMainThread(NS_NewRunnableFunction(
__func__, [aResponse = std::move(aResponse)]() mutable {
LOGD("RunAnalyzeRequestTask on main thread about to send response");
LogResponse(&aResponse);
RefPtr<ContentAnalysis> owner = GetContentAnalysisFromService();
if (!owner) {
// May be shutting down
return;
}
nsCOMPtr<nsIObserverService> obsServ =
mozilla::services::GetObserverService();
// This message is only used for testing purposes, so avoid
// serializing the string here if no one is observing this message.
// This message is only really useful if we're in a timeout
// situation, otherwise dlp-response is fine.
if (obsServ->HasObservers("dlp-response-received-raw")) {
std::string responseString = aResponse.SerializeAsString();
nsTArray<char16_t> responseArray;
responseArray.SetLength(responseString.size() + 1);
for (size_t i = 0; i < responseString.size(); ++i) {
// Since NotifyObservers() expects a null-terminated string,
// make sure none of these values are 0.
responseArray[i] = responseString[i] + 0xFF00;
}
responseArray[responseString.size()] = 0;
obsServ->NotifyObservers(static_cast<nsIContentAnalysis*>(owner),
"dlp-response-received-raw",
responseArray.Elements());
}
Maybe<BasicRequestInfo> maybeBasicRequestInfo;
{
auto map = owner->mRequestTokenToBasicRequestInfoMap.Lock();
maybeBasicRequestInfo =
map->Extract(nsCString(aResponse.request_token()));
}
if (maybeBasicRequestInfo.isNothing()) {
LOGE(
"RunAnalyzeRequestTask could not find userActionId for "
"request token %s",
aResponse.request_token().c_str());
// We have no hope of doing anything useful, so just early return.
return;
}
glean::content_analysis::response_duration_by_analysis_type
.Get(maybeBasicRequestInfo->mAnalysisTypeStr)
.StopAndAccumulate(std::move(maybeBasicRequestInfo->mTimerId));
nsCString userActionId = maybeBasicRequestInfo->mUserActionId;
RefPtr<ContentAnalysisResponse> response =
ContentAnalysisResponse::FromProtobuf(std::move(aResponse),
userActionId);
if (!response) {
LOGE("Content analysis got invalid response!");
return;
}
// We add our own values for action here (eAllow and eCancel)
// so just use the numeric value for glean.
nsAutoCString actionStr;
actionStr.AppendInt(static_cast<int>(response->GetAction()));
glean::content_analysis::response_action.Get(actionStr).Add();
// Normally, if we timeout/user-cancel a request, we remove the
// adjacent entry in mUserActionMap. However, we don't do that if
// the chosen default behavior is to warn. We don't want to issue
// a response in that case.
nsCString requestToken;
MOZ_ALWAYS_SUCCEEDS(response->GetRequestToken(requestToken));
if (owner->mWarnResponseDataMap.Contains(requestToken)) {
return;
}
owner->NotifyObserversAndMaybeIssueResponseFromAgent(
response, std::move(userActionId),
maybeBasicRequestInfo->mAutoAcknowledge);
}));
}
void ContentAnalysis::NotifyResponseObservers(
ContentAnalysisResponse* aResponse, nsCString&& aUserActionId,
bool aAutoAcknowledge, bool aIsTimeout) {
MOZ_ASSERT(NS_IsMainThread());
aResponse->SetOwner(this);
if (aResponse->GetAction() == nsIContentAnalysisResponse::Action::eWarn) {
// Store data so we can asynchronously run the warn dialog, then call
// IssueResponse with the result.
nsCString requestToken;
MOZ_ALWAYS_SUCCEEDS(aResponse->GetRequestToken(requestToken));
mWarnResponseDataMap.InsertOrUpdate(
requestToken, WarnResponseData{aResponse, std::move(aUserActionId),
aAutoAcknowledge, aIsTimeout});
}
nsCOMPtr<nsIObserverService> obsServ =
mozilla::services::GetObserverService();
obsServ->NotifyObservers(static_cast<nsIContentAnalysisResponse*>(aResponse),
"dlp-response", nullptr);
}
void ContentAnalysis::IssueResponse(ContentAnalysisResponse* aResponse,
nsCString&& aUserActionId,
bool aAcknowledge, bool aIsTimeout) {
MOZ_ASSERT(NS_IsMainThread());
MOZ_ASSERT(aResponse->GetAction() !=
nsIContentAnalysisResponse::Action::eWarn);
// Call the callback and maybe send an auto acknowledge.
nsCString token;
MOZ_ALWAYS_SUCCEEDS(aResponse->GetRequestToken(token));
RefPtr<nsIContentAnalysisCallback> callback;
if (auto maybeUserActionData = mUserActionMap.Lookup(aUserActionId)) {
callback = maybeUserActionData->mCallback;
} else {
LOGD(
"ContentAnalysis::IssueResponse user action not found -- already "
"responded | userActionId: %s",
aUserActionId.get());
if (aAcknowledge) {
// Respond to the agent with TOO_LATE because the response arrived
// after the request was cancelled (for any reason).
nsIContentAnalysisAcknowledgement::FinalAction action;
auto userActionIdToCanceledResponseMap =
mUserActionIdToCanceledResponseMap.Lock();
userActionIdToCanceledResponseMap->WithEntryHandle(
aUserActionId, [&](auto&& canceledResponseEntry) {
if (canceledResponseEntry) {
action = canceledResponseEntry->mAction;
--canceledResponseEntry->mNumExpectedResponses;
if (!canceledResponseEntry->mNumExpectedResponses) {
// We've handled all responses for canceled requests for this
// user action.
canceledResponseEntry.Remove();
}
} else {
if (mWarnResponseDataMap.Contains(token)) {
// We got a response from the agent but we're still waiting
// for a warn response from the user. This can basically only
// happen if the request timed out but TimeoutResult=1 (i.e.
// warn) is set.
LOGD(
"Got response from agent for token %s but user hasn't "
"replied to warn dialog yet",
token.get());
return;
}
MOZ_ASSERT_UNREACHABLE("missing canceled response action");
action =
nsIContentAnalysisAcknowledgement::FinalAction::eUnspecified;
}
RefPtr<ContentAnalysisAcknowledgement> acknowledgement =
MakeRefPtr<ContentAnalysisAcknowledgement>(
nsIContentAnalysisAcknowledgement::Result::eTooLate,
action);
aResponse->Acknowledge(acknowledgement);
});
}
return;
}
if (aAcknowledge) {
// Acknowledge every response we receive.
auto acknowledgement = MakeRefPtr<ContentAnalysisAcknowledgement>(
aIsTimeout ? nsIContentAnalysisAcknowledgement::Result::eTooLate
: nsIContentAnalysisAcknowledgement::Result::eSuccess,
ConvertResult(aResponse->GetAction()));
aResponse->Acknowledge(acknowledgement);
}
LOGD("Content analysis notifying observers and calling callback for token %s",
token.get());
callback->ContentResult(aResponse);
// A negative verdict should have removed our user action. (This method
// is not called for warn verdicts.)
MOZ_ASSERT(aResponse->GetShouldAllowContent() ||
!mUserActionMap.Contains(aUserActionId));
}
void ContentAnalysis::NotifyObserversAndMaybeIssueResponseFromAgent(
ContentAnalysisResponse* aResponse, nsCString&& aUserActionId,
bool aAutoAcknowledge) {
NotifyResponseObservers(aResponse, nsCString(aUserActionId), aAutoAcknowledge,
false /* isTimeout */);
// For warn responses, IssueResponse will be called later by
// RespondToWarnDialog, with the action replaced with the user's selection.
if (aResponse->GetAction() != nsIContentAnalysisResponse::Action::eWarn) {
// This is a response from the agent, so not a timeout.
IssueResponse(aResponse, std::move(aUserActionId), aAutoAcknowledge,
false /* aIsTimeout */);
}
}
static void AddCARForText(
nsString&& text, nsIContentAnalysisRequest::Reason aReason,
nsIContentAnalysisRequest::OperationType aOperationType, nsIURI* aURI,
mozilla::dom::WindowGlobalParent* aWindowGlobal,
mozilla::dom::WindowGlobalParent* aSourceWindowGlobal,
nsCString&& aUserActionId,
nsTArray<RefPtr<nsIContentAnalysisRequest>>* aRequests) {
if (text.IsEmpty()) {
// Content Analysis doesn't expect to analyze an empty string.
// Just skip it.
return;
}
LOGD("Adding CA request for text: '%s'", NS_ConvertUTF16toUTF8(text).get());
auto contentAnalysisRequest = MakeRefPtr<ContentAnalysisRequest>(
nsIContentAnalysisRequest::AnalysisType::eBulkDataEntry, aReason,
std::move(text), false, EmptyCString(), aURI, aOperationType,
aWindowGlobal, aSourceWindowGlobal, std::move(aUserActionId));
aRequests->AppendElement(contentAnalysisRequest);
}
void AddCARForUpload(nsString&& filePath,
nsIContentAnalysisRequest::Reason aReason, nsIURI* aURI,
mozilla::dom::WindowGlobalParent* aWindowGlobal,
mozilla::dom::WindowGlobalParent* aSourceWindowGlobal,
nsCString&& aUserActionId,
nsTArray<RefPtr<nsIContentAnalysisRequest>>* aRequests) {
if (filePath.IsEmpty()) {
return;
}
// Let the content analysis code calculate the digest
LOGD("Adding CA request for file: '%s'",
NS_ConvertUTF16toUTF8(filePath).get());
auto contentAnalysisRequest = MakeRefPtr<ContentAnalysisRequest>(
nsIContentAnalysisRequest::AnalysisType::eFileAttached, aReason,
std::move(filePath), true, EmptyCString(), aURI,
nsIContentAnalysisRequest::OperationType::eUpload, aWindowGlobal,
aSourceWindowGlobal, std::move(aUserActionId));
aRequests->AppendElement(contentAnalysisRequest);
}
static nsresult AddClipboardCARForCustomData(
mozilla::dom::WindowGlobalParent* aWindowGlobal, nsITransferable* aTrans,
nsIURI* aURI, mozilla::dom::WindowGlobalParent* aSourceWindowGlobal,
nsCString&& aUserActionId,
nsTArray<RefPtr<nsIContentAnalysisRequest>>* aRequests) {
nsCOMPtr<nsISupports> transferData;
if (StaticPrefs::
browser_contentanalysis_interception_point_clipboard_plain_text_only()) {
return NS_OK;
}
if (NS_FAILED(aTrans->GetTransferData(kCustomTypesMime,
getter_AddRefs(transferData)))) {
return NS_OK; // nothing to check and not an error
}
nsCOMPtr<nsISupportsCString> cStringData = do_QueryInterface(transferData);
if (!cStringData) {
return NS_OK; // nothing to check and not an error
}
nsCString str;
nsresult rv = cStringData->GetData(str);
if (NS_FAILED(rv)) {
return NS_OK; // nothing to check and not an error
}
nsTArray<nsString> texts;
dom::DataTransfer::ParseExternalCustomTypesString(
mozilla::Span(str.Data(), str.Length()),
[&](dom::DataTransfer::ParseExternalCustomTypesStringData&& aData) {
texts.AppendElement(std::move(std::move(aData).second));
});
for (auto& text : texts) {
AddCARForText(std::move(text),
nsIContentAnalysisRequest::Reason::eClipboardPaste,
nsIContentAnalysisRequest::OperationType::eClipboard, aURI,
aWindowGlobal, aSourceWindowGlobal, nsCString(aUserActionId),
aRequests);
}
return NS_OK;
}
static nsresult AddClipboardCARForText(
mozilla::dom::WindowGlobalParent* aWindowGlobal,
nsITransferable* aTextTrans, const char* aFlavor, nsIURI* aURI,
mozilla::dom::WindowGlobalParent* aSourceWindowGlobal,
nsCString&& aUserActionId,
nsTArray<RefPtr<nsIContentAnalysisRequest>>* aRequests) {
nsCOMPtr<nsISupports> transferData;
if (NS_FAILED(
aTextTrans->GetTransferData(aFlavor, getter_AddRefs(transferData)))) {
return NS_OK; // nothing to check and not an error
}
nsString text;
nsCOMPtr<nsISupportsString> textData = do_QueryInterface(transferData);
if (MOZ_LIKELY(textData)) {
if (NS_FAILED(textData->GetData(text))) {
return NS_ERROR_FAILURE;
}
}
if (text.IsEmpty()) {
nsCOMPtr<nsISupportsCString> cStringData = do_QueryInterface(transferData);
if (cStringData) {
nsCString cText;
if (NS_FAILED(cStringData->GetData(cText))) {
return NS_ERROR_FAILURE;
}
text = NS_ConvertUTF8toUTF16(cText);
}
}
AddCARForText(
std::move(text), nsIContentAnalysisRequest::Reason::eClipboardPaste,
nsIContentAnalysisRequest::OperationType::eClipboard, aURI, aWindowGlobal,
aSourceWindowGlobal, std::move(aUserActionId), aRequests);
return NS_OK;
}
static nsresult AddClipboardCARForFile(
mozilla::dom::WindowGlobalParent* aWindowGlobal,
nsITransferable* aFileTrans, nsIURI* aURI,
mozilla::dom::WindowGlobalParent* aSourceWindowGlobal,
nsCString&& aUserActionId,
nsTArray<RefPtr<nsIContentAnalysisRequest>>* aRequests) {
nsCOMPtr<nsISupports> transferData;
nsresult rv =
aFileTrans->GetTransferData(kFileMime, getter_AddRefs(transferData));
if (NS_SUCCEEDED(rv)) {
if (nsCOMPtr<nsIFile> file = do_QueryInterface(transferData)) {
nsString filePath;
NS_ENSURE_SUCCESS(file->GetPath(filePath), NS_ERROR_FAILURE);
AddCARForUpload(std::move(filePath),
nsIContentAnalysisRequest::Reason::eClipboardPaste, aURI,
aWindowGlobal, aSourceWindowGlobal,
std::move(aUserActionId), aRequests);
} else {
MOZ_ASSERT_UNREACHABLE("clipboard data had kFileMime but no nsIFile!");
return NS_ERROR_FAILURE;
}
}
return NS_OK;
}
static Result<bool, nsresult> AddRequestsFromTransferableIfAny(
nsIContentAnalysisRequest* aOriginalRequest, nsIURI* aUri,
mozilla::dom::WindowGlobalParent* aWindowGlobal,
mozilla::dom::WindowGlobalParent* aSourceWindowGlobal,
nsTArray<RefPtr<nsIContentAnalysisRequest>>* aNewRequests) {
NS_ENSURE_TRUE(aNewRequests, Err(NS_ERROR_INVALID_ARG));
nsCOMPtr<nsITransferable> transferable;
NS_ENSURE_SUCCESS(
aOriginalRequest->GetTransferable(getter_AddRefs(transferable)),
Err(NS_ERROR_FAILURE));
if (!transferable) {
return false;
}
nsAutoCString userActionId;
MOZ_ALWAYS_SUCCEEDS(aOriginalRequest->GetUserActionId(userActionId));
nsresult rv = AddClipboardCARForCustomData(
aWindowGlobal, transferable, aUri, aSourceWindowGlobal,
nsCString(userActionId), aNewRequests);
NS_ENSURE_SUCCESS(rv, Err(rv));
for (const auto& textFormat : kTextFormatsToAnalyze) {
rv = AddClipboardCARForText(aWindowGlobal, transferable, textFormat, aUri,
aSourceWindowGlobal, nsCString(userActionId),
aNewRequests);
NS_ENSURE_SUCCESS(rv, Err(rv));
if (StaticPrefs::
browser_contentanalysis_interception_point_clipboard_plain_text_only()) {
// kTextMime is the first entry in kTextFormatsToAnalyze
break;
}
}
rv = AddClipboardCARForFile(aWindowGlobal, transferable, aUri,
aSourceWindowGlobal, std::move(userActionId),
aNewRequests);
NS_ENSURE_SUCCESS(rv, Err(rv));
return true;
}
static Result<bool, nsresult> AddRequestsFromDataTransferIfAny(
nsIContentAnalysisRequest* aOriginalRequest, nsIURI* aUri,
mozilla::dom::WindowGlobalParent* aWindowGlobal,
mozilla::dom::WindowGlobalParent* aSourceWindowGlobal,
nsTArray<RefPtr<nsIContentAnalysisRequest>>* aNewRequests) {
NS_ENSURE_TRUE(aNewRequests, Err(NS_ERROR_INVALID_ARG));
nsCOMPtr<dom::DataTransfer> dataTransfer;
NS_ENSURE_SUCCESS(
aOriginalRequest->GetDataTransfer(getter_AddRefs(dataTransfer)),
Err(NS_ERROR_FAILURE));
if (!dataTransfer) {
return false;
}
nsAutoCString userActionId;
MOZ_ALWAYS_SUCCEEDS(aOriginalRequest->GetUserActionId(userActionId));
auto& principal = *nsContentUtils::GetSystemPrincipal();
for (const auto& textFormat : kTextFormatsToAnalyze) {
nsAutoString text;
ErrorResult error;
// If format is not found then 'text' will be empty.
dataTransfer->GetData(nsString(NS_ConvertUTF8toUTF16(textFormat)), text,
principal, error);
NS_ENSURE_TRUE(!error.Failed(), Err(error.StealNSResult()));
AddCARForText(std::move(text),
nsIContentAnalysisRequest::Reason::eDragAndDrop,
nsIContentAnalysisRequest::OperationType::eDroppedText, aUri,
aWindowGlobal, aSourceWindowGlobal, nsCString(userActionId),
aNewRequests);
if (StaticPrefs::
browser_contentanalysis_interception_point_drag_and_drop_plain_text_only()) {
// kTextMime is the first entry in kTextFormatsToAnalyze
break;
}
}
if (dataTransfer->HasFile()) {
RefPtr fileList = dataTransfer->GetFiles(principal);
for (uint32_t i = 0; i < fileList->Length(); ++i) {
auto* file = fileList->Item(i);
if (!file) {
continue;
}
nsString filePath;
ErrorResult error;
file->GetMozFullPathInternal(filePath, error);
NS_ENSURE_TRUE(!error.Failed(), Err(error.StealNSResult()));
AddCARForUpload(std::move(filePath),
nsIContentAnalysisRequest::Reason::eDragAndDrop, aUri,
aWindowGlobal, aSourceWindowGlobal,
nsCString(userActionId), aNewRequests);
}
}
return true;
}
Result<already_AddRefed<nsIContentAnalysisRequest>, nsresult>
MakeRequestForFileInFolder(dom::File* aFile,
nsIContentAnalysisRequest* aFolderRequest) {
nsCOMPtr<nsIURI> url;
nsresult rv = aFolderRequest->GetUrl(getter_AddRefs(url));
NS_ENSURE_SUCCESS(rv, Err(rv));
nsIContentAnalysisRequest::AnalysisType analysisType;
rv = aFolderRequest->GetAnalysisType(&analysisType);
NS_ENSURE_SUCCESS(rv, Err(rv));
nsIContentAnalysisRequest::Reason reason;
rv = aFolderRequest->GetReason(&reason);
NS_ENSURE_SUCCESS(rv, Err(rv));
nsIContentAnalysisRequest::OperationType operationType;
rv = aFolderRequest->GetOperationTypeForDisplay(&operationType);
NS_ENSURE_SUCCESS(rv, Err(rv));
RefPtr<dom::WindowGlobalParent> windowGlobal;
rv = aFolderRequest->GetWindowGlobalParent(getter_AddRefs(windowGlobal));
NS_ENSURE_SUCCESS(rv, Err(rv));
RefPtr<mozilla::dom::WindowGlobalParent> sourceWindowGlobal;
rv =
aFolderRequest->GetSourceWindowGlobal(getter_AddRefs(sourceWindowGlobal));
NS_ENSURE_SUCCESS(rv, Err(rv));
nsCString userActionId;
rv = aFolderRequest->GetUserActionId(userActionId);
NS_ENSURE_SUCCESS(rv, Err(rv));
nsAutoString pathString;
mozilla::ErrorResult error;
aFile->GetMozFullPathInternal(pathString, error);
rv = error.StealNSResult();
NS_ENSURE_SUCCESS(rv, Err(rv));
return MakeRefPtr<ContentAnalysisRequest>(
analysisType, reason, pathString, true, EmptyCString(), url,
operationType, windowGlobal, sourceWindowGlobal,
std::move(userActionId))
.forget()
.downcast<nsIContentAnalysisRequest>();
}
RefPtr<ContentAnalysis::MultipartRequestCallback>
ContentAnalysis::MultipartRequestCallback::Create(
ContentAnalysis* aContentAnalysis,
const nsTArray<ContentAnalysis::ContentAnalysisRequestArray>& aRequests,
nsIContentAnalysisCallback* aCallback, bool aAutoAcknowledge) {
auto mpcb = MakeRefPtr<MultipartRequestCallback>();
mpcb->Initialize(aContentAnalysis, aRequests, aCallback, aAutoAcknowledge);
return mpcb;
}
void ContentAnalysis::MultipartRequestCallback::Initialize(
ContentAnalysis* aContentAnalysis,
const nsTArray<ContentAnalysis::ContentAnalysisRequestArray>& aRequests,
nsIContentAnalysisCallback* aCallback, bool aAutoAcknowledge) {
MOZ_ASSERT(aContentAnalysis);
MOZ_ASSERT(aCallback);
MOZ_ASSERT(NS_IsMainThread());
mWeakContentAnalysis = aContentAnalysis;
mCallback = aCallback;
mNumCARequestsRemaining = 0;
nsTHashSet<nsCString> requestTokens;
if (!aRequests.IsEmpty()) {
for (const auto& requests : aRequests) {
mNumCARequestsRemaining += requests.Length();
}
for (const auto& requests : aRequests) {
for (const auto& request : requests) {
// Pull the user action ID from the first entry we find. They will
// all have the same ID. If that ID isn't in the user action map
// then we were canceled while we were building the request list.
// In that case, we haven't called the callback, so do that here.
if (mUserActionId.IsEmpty()) {
MOZ_ALWAYS_SUCCEEDS(request->GetUserActionId(mUserActionId));
MOZ_ASSERT(!mUserActionId.IsEmpty());
if (!mWeakContentAnalysis->mUserActionMap.Contains(mUserActionId)) {
LOGD(
"ContentAnalysis::MultipartRequestCallback created after "
"request was canceled. Calling callback.");
RefPtr result = MakeRefPtr<ContentAnalysisActionResult>(
nsIContentAnalysisResponse::Action::eCanceled);
mCallback->ContentResult(result);
mResponded = true;
return;
}
}
MOZ_ALWAYS_SUCCEEDS(
request->SetUserActionRequestsCount(mNumCARequestsRemaining));
nsCString requestToken;
MOZ_ALWAYS_SUCCEEDS(request->GetRequestToken(requestToken));
if (requestToken.IsEmpty()) {
requestToken = GenerateUUID();
MOZ_ALWAYS_SUCCEEDS(request->SetRequestToken(requestToken));
}
requestTokens.Insert(requestToken);
}
}
}
if (mNumCARequestsRemaining == 0) {
// No requests will be submitted so no response will be sent by agent.
// Respond now instead.
LOGD(
"Content analysis requested but nothing needs to be checked. "
"Request is approved.");
RefPtr result = MakeRefPtr<ContentAnalysisActionResult>(
nsIContentAnalysisResponse::Action::eAllow);
aCallback->ContentResult(result);
return;
}
LOGD("ContentAnalysis processing %zu given and synthesized requests",
mNumCARequestsRemaining);
MOZ_ASSERT(!mUserActionId.IsEmpty());
MOZ_ASSERT(!requestTokens.IsEmpty());
auto checkedTimeoutMs =
CheckedInt32(StaticPrefs::browser_contentanalysis_agent_timeout()) *
1000 * mNumCARequestsRemaining;
auto timeoutMs = checkedTimeoutMs.isValid()
? checkedTimeoutMs.value()
: std::numeric_limits<int32_t>::max();
// Non-positive timeout values indicate testing, and the test agent does not
// care about this value. Use 25ms (unscaled) in that case.
timeoutMs = std::max(timeoutMs, 25);
RefPtr timeoutRunnable = NS_NewCancelableRunnableFunction(
"ContentAnalysis timeout",
[userActionId = mUserActionId,
weakContentAnalysis = mWeakContentAnalysis]() mutable {
if (!weakContentAnalysis) {
return;
}
// Entries awaiting a warn-dialog-selection should not be
// considered as part of timeout. Ignore timeout if all remaining
// requests are awaiting a warn respones. Otherwise cancel all of
// them (including any awaiting a warn response) as timed out.
bool found = false;
if (auto remainingEntry =
weakContentAnalysis->mUserActionMap.Lookup(userActionId)) {
MOZ_ASSERT(!remainingEntry->mIsHandlingTimeout);
for (const auto& remainingToken : remainingEntry->mRequestTokens) {
if (!weakContentAnalysis->mWarnResponseDataMap.Contains(
remainingToken)) {
// This request is not awaiting warn so cancel the entire user
// action.
found = true;
// We do not allow calling Cancel() on runnables while they are
// running, so this makes sure that CA does not do that.
remainingEntry->mIsHandlingTimeout = true;
break;
}
}
}
if (found) {
weakContentAnalysis->CancelWithError(std::move(userActionId),
NS_ERROR_DOM_TIMEOUT_ERR);
}
});
NS_DelayedDispatchToCurrentThread((RefPtr{timeoutRunnable}).forget(),
timeoutMs);
// Update our entry in the user action map with the request tokens and a
// timeout event.
auto uaData = UserActionData{this, std::move(requestTokens), timeoutRunnable,
aAutoAcknowledge};
MOZ_ASSERT(mWeakContentAnalysis->mUserActionMap.Lookup(mUserActionId));
mWeakContentAnalysis->mUserActionMap.InsertOrUpdate(mUserActionId,
std::move(uaData));
}
NS_IMETHODIMP
ContentAnalysis::MultipartRequestCallback::ContentResult(
nsIContentAnalysisResult* aResult) {
MOZ_ASSERT(NS_IsMainThread());
if (mWeakContentAnalysis) {
// Remove aResult's request token from the remaining requests list.
if (auto maybeUserActionData =
mWeakContentAnalysis->mUserActionMap.Lookup(mUserActionId)) {
nsCOMPtr<nsIContentAnalysisResponse> response =
do_QueryInterface(aResult);
MOZ_ASSERT(response);
nsAutoCString token;
MOZ_ALWAYS_SUCCEEDS(response->GetRequestToken(token));
DebugOnly<bool> removed =
maybeUserActionData->mRequestTokens.EnsureRemoved(token);
// Either we removed the token or it was previously removed, along with
// all others, as part of a cancellation.
MOZ_ASSERT(removed || maybeUserActionData->mRequestTokens.IsEmpty(),
"Request token was not found");
}
}
if (mResponded) {
return NS_OK;
}
bool allow = aResult->GetShouldAllowContent();
--mNumCARequestsRemaining;
if (allow && mNumCARequestsRemaining > 0) {
LOGD(
"MultipartRequestCallback received allow response. Awaiting "
"%zu remaining responses",
mNumCARequestsRemaining);
return NS_OK;
}
LOGD("MultipartRequestCallback issuing response. Permitted? %s",
allow ? "yes" : "no");
mResponded = true;
mCallback->ContentResult(aResult);
if (!allow) {
CancelRequests();
} else {
RemoveFromUserActionMap();
}
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysis::MultipartRequestCallback::Error(nsresult aRv) {
MOZ_ASSERT(NS_IsMainThread());
if (mResponded) {
return NS_OK;
}
LOGD(
"MultipartRequestCallback received %s while awaiting "
"%zu remaining responses",
SafeGetStaticErrorName(aRv), mNumCARequestsRemaining);
mResponded = true;
mCallback->Error(aRv);
CancelRequests();
return NS_OK;
}
ContentAnalysis::MultipartRequestCallback::~MultipartRequestCallback() {
MOZ_ASSERT(NS_IsMainThread());
// Either we have called our callback and removed our userActionId or we are
// shutting down.
MOZ_ASSERT(!mWeakContentAnalysis || mWeakContentAnalysis->IsShutDown() ||
!mWeakContentAnalysis->mUserActionMap.Contains(mUserActionId));
}
void ContentAnalysis::MultipartRequestCallback::CancelRequests() {
MOZ_ASSERT(mResponded);
// If any request fails to be submitted or is rejected then we need to
// cancel all of the other outstanding requests. Note that we may be
// getting here as part of being cancelled already, in which case we
// have nothing to cancel but our caller may still be cancelling requests
// from our user action, which is fine.
if (mWeakContentAnalysis) {
mWeakContentAnalysis->CancelRequestsByUserAction(mUserActionId);
}
}
void ContentAnalysis::MultipartRequestCallback::RemoveFromUserActionMap() {
if (mWeakContentAnalysis) {
mWeakContentAnalysis->RemoveFromUserActionMap(nsCString(mUserActionId));
}
}
void ContentAnalysis::RemoveFromUserActionMap(nsCString&& aUserActionId) {
if (auto entry = mUserActionMap.Lookup(aUserActionId)) {
// Implementation note: we need mIsHandlingTimeout because this is called
// during mTimeoutRunnable and CancelableRunnable is not robust to having
// Cancel called at that time.
if (entry->mTimeoutRunnable && !entry->mIsHandlingTimeout) {
// Timeout may or may not have been called.
entry->mTimeoutRunnable->Cancel();
}
entry.Remove();
}
}
NS_IMPL_QUERY_INTERFACE(ContentAnalysis::MultipartRequestCallback,
nsIContentAnalysisCallback)
Result<RefPtr<ContentAnalysis::RequestsPromise>, nsresult>
ContentAnalysis::ExpandFolderRequest(nsIContentAnalysisRequest* aRequest,
nsIFile* file) {
// We just need to iterate over the directory, so use the junk scope
RefPtr<mozilla::dom::Directory> directory = mozilla::dom::Directory::Create(
xpc::NativeGlobal(xpc::PrivilegedJunkScope()), file);
NS_ENSURE_TRUE(directory, Err(NS_ERROR_FAILURE));
mozilla::dom::OwningFileOrDirectory owningDirectory;
owningDirectory.SetAsDirectory() = directory;
nsTArray<mozilla::dom::OwningFileOrDirectory> directoryArray{
std::move(owningDirectory)};
using mozilla::dom::GetFilesHelper;
mozilla::ErrorResult error;
RefPtr<GetFilesHelper> helper =
GetFilesHelper::Create(directoryArray, true /* aRecursiveFlag */, error);
nsresult rv = error.StealNSResult();
NS_ENSURE_SUCCESS(rv, Err(rv));
auto gfhPromise = MakeRefPtr<GetFilesHelper::MozPromiseType>(__func__);
helper->AddMozPromise(gfhPromise,
xpc::NativeGlobal(xpc::PrivilegedJunkScope()));
// Use MozPromise chaining (the undocumented feature where returning a
// MozPromise from handlers chains to that new promise). The chained
// promise is the RequestsPromise that will resolve to requests for each
// file in the folder.
RefPtr<RequestsPromise> requestPromise = gfhPromise->Then(
GetMainThreadSerialEventTarget(), "make ca file requests",
[request = RefPtr{aRequest}](
const nsTArray<RefPtr<mozilla::dom::File>>& aFiles) {
ContentAnalysisRequestArray requests(aFiles.Length());
for (const auto& file : aFiles) {
auto requestOrError = MakeRequestForFileInFolder(file, request);
if (requestOrError.isErr()) {
return RequestsPromise::CreateAndReject(requestOrError.unwrapErr(),
__func__);
}
requests.AppendElement(requestOrError.unwrap());
}
return RequestsPromise::CreateAndResolve(requests, __func__);
},
[](nsresult rv) {
return RequestsPromise::CreateAndReject(NS_ERROR_FAILURE, __func__);
});
return requestPromise;
}
// Asynchronously expand/filter requests based on policies that bypass
// the agent. This includes replacing folder requests with requests to scan
// their contents (files), etc. Returns either promises for all remaining
// requests (provided and synthetic) or a ContentAnalysisResult if no
// requests need to be run.
Result<RefPtr<ContentAnalysis::RequestsPromise::AllPromiseType>,
RefPtr<nsIContentAnalysisResult>>
ContentAnalysis::GetFinalRequestList(
const ContentAnalysisRequestArray& aRequests) {
Maybe<NoContentAnalysisResult> allowResult;
// We keep allowResult just in case all requests end up getting filtered.
// It gives us an explanation for that. If any requests survive this
// function then allowResult isn't returned. Negative results should
// be returned early. They should not set allowResult.
auto setAllowResult = [&allowResult](NoContentAnalysisResult aVal) {
DebugOnly checkResult = [aVal]() {
return MakeRefPtr<ContentAnalysisNoResult>(aVal)->GetShouldAllowContent();
};
// shouldAllowContent must be true.
MOZ_ASSERT(checkResult.value());
if (!allowResult) {
allowResult = Some(aVal);
return;
}
if (*allowResult == NoContentAnalysisResult::
ALLOW_DUE_TO_CONTEXT_EXEMPT_FROM_CONTENT_ANALYSIS) {
// Allow aVal to override the prior allow result.
allowResult = Some(aVal);
}
};
// Expand the DataTransfer and Transferable requests into requests for
// their individual contents. Also filter out the requests that don't
// need to be run.
ContentAnalysisRequestArray expandedTransferRequests(aRequests.Length());
for (const auto& request : aRequests) {
// Check request's reason to see if prefs always permit this operation.
nsIContentAnalysisRequest::Reason reason;
MOZ_ALWAYS_SUCCEEDS(request->GetReason(&reason));
if (!ShouldCheckReason(reason)) {
LOGD("Allowing request -- operations of this type are always permitted.");
setAllowResult(NoContentAnalysisResult::
ALLOW_DUE_TO_CONTEXT_EXEMPT_FROM_CONTENT_ANALYSIS);
continue;
}
// Content analysis is only needed if an outside webpage has access to
// the data. So, skip content analysis if there is:
// - the window is a chrome docshell
// - the window is being rendered in the parent process (for example,
// about:support and the like)
RefPtr<mozilla::dom::WindowGlobalParent> windowGlobal;
request->GetWindowGlobalParent(getter_AddRefs(windowGlobal));
nsCOMPtr<nsIURI> uri;
request->GetUrl(getter_AddRefs(uri));
// NOTE: We only consider uri here (when windowGlobal isn't specified)
// for current tests to work. gtests specify URI but no window.
// We should never "really" hit that condition.
if ((!windowGlobal && !uri) ||
(windowGlobal && (windowGlobal->GetBrowsingContext()->IsChrome() ||
windowGlobal->IsInProcess()))) {
LOGD("Allowing request -- window was null or chrome or in-process.");
setAllowResult(NoContentAnalysisResult::
ALLOW_DUE_TO_CONTEXT_EXEMPT_FROM_CONTENT_ANALYSIS);
continue;
}
// Maybe skip check if source of operation is same tab.
if (mozilla::StaticPrefs::
browser_contentanalysis_bypass_for_same_tab_operations() &&
SourceIsSameTab(request)) {
// ALLOW_DUE_TO_SAME_TAB_SOURCE may replace a result of
// ALLOW_DUE_TO_CONTEXT_EXEMPT_FROM_CONTENT_ANALYSIS from an earlier
// request.
LOGD(
"Allowing request -- same tab operations are always permitted by "
"pref.");
setAllowResult(NoContentAnalysisResult::ALLOW_DUE_TO_SAME_TAB_SOURCE);
continue;
}
// Check if the context is privileged.
if (!uri) {
// If no URL is given then use the one for the window.
uri = ContentAnalysis::GetURIForBrowsingContext(
windowGlobal->Canonical()->GetBrowsingContext());
if (!uri) {
// if we still have no URL then the request is from a privileged window
LOGD("Allowing request -- priviledged window.");
setAllowResult(NoContentAnalysisResult::
ALLOW_DUE_TO_CONTEXT_EXEMPT_FROM_CONTENT_ANALYSIS);
continue;
}
}
// Check URLs of requested info against
// browser.contentanalysis.allow_url_regex_list/deny_url_regex_list.
// Build the list once since creating regexs is slow.
// Requests with URLs that match the allow list are removed from the check.
// There is only one URL in all cases except downloads. If all contents
// are removed or the page URL is allowed (for downloads) then the
// operation is allowed.
// Requests with URLs that match the deny list block the entire operation.
auto filterResult = FilterByUrlLists(request, uri);
if (filterResult == ContentAnalysis::UrlFilterResult::eDeny) {
LOGD("Blocking request due to deny URL filter.");
glean::content_analysis::request_blocked_by_deny_url.Add();
return Err(MakeRefPtr<ContentAnalysisActionResult>(
nsIContentAnalysisResponse::Action::eBlock));
}
if (filterResult == ContentAnalysis::UrlFilterResult::eAllow) {
LOGD("Allowing request -- all operations match allow URL filter.");
glean::content_analysis::request_allowed_by_allow_url.Add();
setAllowResult(NoContentAnalysisResult::
ALLOW_DUE_TO_CONTEXT_EXEMPT_FROM_CONTENT_ANALYSIS);
continue;
}
RefPtr<dom::WindowGlobalParent> sourceWindowGlobal;
request->GetSourceWindowGlobal(getter_AddRefs(sourceWindowGlobal));
Result<bool, nsresult> hadTransferOrError =
AddRequestsFromTransferableIfAny(request, uri, windowGlobal,
sourceWindowGlobal,
&expandedTransferRequests);
if (hadTransferOrError.isOk() && !hadTransferOrError.unwrap()) {
// Request didn't have a Transferable with contents. Check for a
// DataTransfer.
hadTransferOrError = AddRequestsFromDataTransferIfAny(
request, uri, windowGlobal, sourceWindowGlobal,
&expandedTransferRequests);
if (hadTransferOrError.isOk() && !hadTransferOrError.unwrap()) {
// Request didn't have a Transferable or DataTransfer with contents.
// Copy it as-is.
expandedTransferRequests.AppendElement(request);
}
}
if (hadTransferOrError.isErr()) {
LOGD(
"Denying request -- error expanding nsITransferable or "
"DataTransfer.");
return RequestsPromise::AllPromiseType::CreateAndReject(
hadTransferOrError.unwrapErr(), __func__);
}
}
// We have expanded all Transferable and DataTransfer requests. We now
// look for folder requests to expand.
ContentAnalysisRequestArray nonFolderRequests;
nsTArray<RefPtr<RequestsPromise>> promises;
for (auto& request : expandedTransferRequests) {
// Always add request to nonFolderRequests unless we process a folder for
// it. Note that the scope for this MakeScopeExit is the for loop, not the
// function.
auto copyRequest =
MakeScopeExit([&]() { nonFolderRequests.AppendElement(request); });
nsAutoString filename;
nsresult rv = request->GetFilePath(filename);
NS_ENSURE_SUCCESS(
rv, RequestsPromise::AllPromiseType::CreateAndReject(rv, __func__));
if (filename.IsEmpty()) {
// Not a file so just copy the request to nonFolderRequests.
continue;
}
#ifdef DEBUG
// Confirm that there is no text content to analyze. See comment on
// mFilePath.
nsAutoString textContent;
rv = request->GetTextContent(textContent);
MOZ_ASSERT(NS_SUCCEEDED(rv));
MOZ_ASSERT(textContent.IsEmpty());
#endif
RefPtr<nsIFile> file;
rv = NS_NewLocalFile(filename, getter_AddRefs(file));
NS_ENSURE_SUCCESS(
rv, RequestsPromise::AllPromiseType::CreateAndReject(rv, __func__));
bool exists;
rv = file->Exists(&exists);
NS_ENSURE_SUCCESS(
rv, RequestsPromise::AllPromiseType::CreateAndReject(rv, __func__));
if (!exists) {
continue;
}
bool isDir;
rv = file->IsDirectory(&isDir);
NS_ENSURE_SUCCESS(
rv, RequestsPromise::AllPromiseType::CreateAndReject(rv, __func__));
if (!isDir) {
continue;
}
// Don't copy the folder request.
copyRequest.release();
LOGD("GetFinalRequestList expanding folder: %s",
NS_ConvertUTF16toUTF8(filename.get()).get());
Result<RefPtr<RequestsPromise>, nsresult> requestPromiseOrError =
ExpandFolderRequest(request, file);
if (requestPromiseOrError.isErr()) {
LOGD("Denying request -- error expanding folder.");
return RequestsPromise::AllPromiseType::CreateAndReject(
requestPromiseOrError.unwrapErr(), __func__);
}
promises.AppendElement(requestPromiseOrError.unwrap());
}
// We have expanded all requests to check folders, Transferables and
// DataTransfers.
if (!nonFolderRequests.IsEmpty()) {
promises.AppendElement(RequestsPromise::CreateAndResolve(
std::move(nonFolderRequests), "non folder requests"));
}
if (promises.IsEmpty()) {
if (allowResult) {
LOGD(
"Allowing request -- all requests were permitted early. "
"NoContentAnalysisResult = %d",
(int)*allowResult);
return Err(MakeRefPtr<ContentAnalysisNoResult>(*allowResult));
}
// This can happen e.g. if the requests were for empty folders, etc.
LOGD("Allowing request -- no requests need to be checked.");
return Err(MakeRefPtr<ContentAnalysisNoResult>(
NoContentAnalysisResult::
ALLOW_DUE_TO_CONTEXT_EXEMPT_FROM_CONTENT_ANALYSIS));
}
// If there were any requests then ignore any allowResult because we still
// have to do the remaining checks.
return RequestsPromise::All(GetMainThreadSerialEventTarget(), promises);
}
NS_IMETHODIMP
ContentAnalysis::AnalyzeContentRequests(
const nsTArray<RefPtr<nsIContentAnalysisRequest>>& aRequests,
bool aAutoAcknowledge, JSContext* aCx, mozilla::dom::Promise** aPromise) {
RefPtr<mozilla::dom::Promise> promise;
nsresult rv = MakePromise(aCx, getter_AddRefs(promise));
NS_ENSURE_SUCCESS(rv, rv);
RefPtr<ContentAnalysisCallback> callback =
new ContentAnalysisCallback(promise);
promise.forget(aPromise);
return AnalyzeContentRequestsCallback(aRequests, aAutoAcknowledge, callback);
}
NS_IMETHODIMP
ContentAnalysis::AnalyzeContentRequestsCallback(
const nsTArray<RefPtr<nsIContentAnalysisRequest>>& aRequests,
bool aAutoAcknowledge, nsIContentAnalysisCallback* aCallback) {
MOZ_ASSERT(NS_IsMainThread());
NS_ENSURE_ARG(aCallback);
LOGD("ContentAnalysis::AnalyzeContentRequestsCallback received %zu requests",
aRequests.Length());
// Wrap callback in a ContentAnalysisCallback, which will assert if the
// callback is not called exactly once.
auto safeCallback = MakeRefPtr<ContentAnalysisCallback>(aCallback);
// If any member of aRequests has a different user action ID than another,
// throw an error. If the user action IDs are empty, generate one and set
// it for the requests.
nsAutoCString userActionId;
bool isSettingId = false;
if (!aRequests.IsEmpty()) {
MOZ_ALWAYS_SUCCEEDS(aRequests[0]->GetUserActionId(userActionId));
if (userActionId.IsEmpty()) {
userActionId = GenerateUUID();
isSettingId = true;
}
}
for (const auto& request : aRequests) {
if (isSettingId) {
MOZ_ALWAYS_SUCCEEDS(request->SetUserActionId(userActionId));
} else {
nsAutoCString givenUserActionId;
MOZ_ALWAYS_SUCCEEDS(request->GetUserActionId(givenUserActionId));
if (givenUserActionId != userActionId) {
safeCallback->Error(NS_ERROR_INVALID_ARG);
return NS_ERROR_INVALID_ARG;
}
}
}
mUserActionMap.InsertOrUpdate(
userActionId, UserActionData{aCallback, {}, nullptr, aAutoAcknowledge});
Result<RefPtr<RequestsPromise::AllPromiseType>,
RefPtr<nsIContentAnalysisResult>>
requestListResult = GetFinalRequestList(aRequests);
if (requestListResult.isErr()) {
auto result = requestListResult.unwrapErr();
LOGD(
"ContentAnalysis::AnalyzeContentRequestsCallback received early result "
"before creating the final request list | shouldAllow = %s",
result->GetShouldAllowContent() ? "yes" : "no");
// On a negative result, create only one failure dialog. For a positive
// result, we don't bother since there is no visual indication needed.
if (!result->GetShouldAllowContent()) {
if (!aRequests.IsEmpty()) {
ShowBlockedRequestDialog(aRequests[0]);
} else {
// No dialog could be shown since we have no window.
LOGD("Got a negative response for an empty request?");
}
}
safeCallback->ContentResult(result);
mUserActionMap.Remove(userActionId);
return NS_OK;
}
// We need to pass this object to the lambda below because we need to
// guarantee that we can get this "real" object, not a mock, for
// MultipartRequestCallback.
WeakPtr<ContentAnalysis> weakThis = this;
RefPtr<RequestsPromise::AllPromiseType> finalRequests =
requestListResult.unwrap();
finalRequests->Then(
GetMainThreadSerialEventTarget(), "issue ca requests",
[aAutoAcknowledge, safeCallback, weakThis,
userActionId](nsTArray<ContentAnalysisRequestArray>&& aRequests) {
// We already have weakThis but we also get the nsIContentAnalysis
// object from the service, since we do want the mock service (if
// any) for the call to AnalyzeContentRequestPrivate.
// In non-test runs, they will always be the same object.
nsCOMPtr<nsIContentAnalysis> contentAnalysis =
mozilla::components::nsIContentAnalysis::Service();
if (!contentAnalysis || !weakThis) {
LOGD(
"ContentAnalysis::AnalyzeContentRequestsCallback received "
"response during shutdown | userActionId = %s",
userActionId.get());
safeCallback->Error(NS_ERROR_NOT_AVAILABLE);
return;
}
RefPtr<MultipartRequestCallback> mpcb =
MultipartRequestCallback::Create(weakThis, aRequests, safeCallback,
aAutoAcknowledge);
if (mpcb->HasResponded()) {
// Already responded because the request has been canceled already
// (or some other error)
return;
}
for (const auto& requests : aRequests) {
for (const auto& request : requests) {
contentAnalysis->AnalyzeContentRequestPrivate(
request, aAutoAcknowledge, mpcb);
}
}
},
[safeCallback, weakThis, userActionId](nsresult rv) {
LOGD(
"ContentAnalysis::AnalyzeContentRequestsCallback received error "
"response: %s | userActionId = %s",
SafeGetStaticErrorName(rv), userActionId.get());
safeCallback->Error(rv);
if (weakThis) {
weakThis->mUserActionMap.Remove(userActionId);
}
});
return NS_OK;
}
NS_IMETHODIMP ContentAnalysis::AnalyzeContentRequestPrivate(
nsIContentAnalysisRequest* aRequest, bool aAutoAcknowledge,
nsIContentAnalysisCallback* aCallback) {
MOZ_ASSERT(NS_IsMainThread());
// We check this here so that async calls to this method (e.g. via a promise
// resolve) don't send requests after being told not to.
if (mForbidFutureRequests) {
nsCString requestToken;
nsresult rv = aRequest->GetRequestToken(requestToken);
NS_ENSURE_SUCCESS(rv, rv);
LOGD(
"ContentAnalysis received request [%p](%s) "
"after forbidding future requests. Request is rejected.",
aRequest, requestToken.get());
aCallback->Error(NS_ERROR_ILLEGAL_DURING_SHUTDOWN);
return NS_OK;
}
LOGD(
"ContentAnalysis::AnalyzeContentRequestPrivate analyzing request [%p] "
"with callback [%p]",
aRequest, aCallback);
auto se = MakeScopeExit([&]() {
LOGE("AnalyzeContentRequestPrivate failed");
aCallback->Error(NS_ERROR_FAILURE);
});
// Make sure we send the notification first, so if we later return
// an error the JS will handle it correctly.
nsCOMPtr<nsIObserverService> obsServ =
mozilla::services::GetObserverService();
obsServ->NotifyObservers(aRequest, "dlp-request-made", nullptr);
bool isActive;
nsresult rv = GetIsActive(&isActive);
NS_ENSURE_SUCCESS(rv, rv);
if (!isActive) {
return NS_ERROR_NOT_AVAILABLE;
}
++mRequestCount;
se.release();
// since we're on the main thread, don't need to synchronize this
return RunAnalyzeRequestTask(aRequest, aAutoAcknowledge, aCallback);
}
NS_IMETHODIMP
ContentAnalysis::CancelAllRequestsAssociatedWithUserAction(
const nsACString& aUserActionId) {
MOZ_ASSERT(NS_IsMainThread());
// Find the compound action containing aUserActionId, if any.
RefPtr<const UserActionSet> compoundUserAction;
for (auto iter = mCompoundUserActions.iter(); !iter.done(); iter.next()) {
auto& entry = iter.get();
if (entry->has(nsCString(aUserActionId))) {
compoundUserAction = entry;
break;
}
}
if (!compoundUserAction) {
// It was not a compound request, just a single one.
return CancelRequestsByUserAction(aUserActionId);
}
MOZ_ASSERT(!compoundUserAction->empty());
// NB: We don't filter out completed user actions from the compound list
// since we may need to look them up for this function later. So we may
// end up canceling requests that are already completed here -- that is a
// no-op.
LOGD("Cancelling %u requests associated with user action ID: %s",
compoundUserAction->count(), aUserActionId.Data());
nsresult rv = NS_OK;
for (auto iter = compoundUserAction->iter(); !iter.done(); iter.next()) {
nsresult rv2 = CancelRequestsByUserAction(iter.get());
if (NS_FAILED(rv2)) {
rv = rv2;
}
// If we find a user action ID for a request that is not yet complete then
// canceling it will cancel and remove the entire compound action. In that
// case, we are done.
if (!mCompoundUserActions.has(compoundUserAction)) {
break;
}
}
LOGD(
"Cancelling compound request associated with user action ID: %s %s | "
"Error code: %s",
aUserActionId.Data(),
(!mCompoundUserActions.has(compoundUserAction)) ? "succeeded" : "failed",
SafeGetStaticErrorName(rv));
return rv;
}
NS_IMETHODIMP
ContentAnalysis::CancelRequestsByUserAction(const nsACString& aUserActionId) {
MOZ_ASSERT(NS_IsMainThread());
CancelWithError(nsCString(aUserActionId), NS_ERROR_ABORT);
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysis::CancelAllRequests(bool aForbidFutureRequests) {
MOZ_ASSERT(NS_IsMainThread());
LOGD(
"CancelAllRequests running | aForbidFutureRequests: %s | number of "
"outstanding UserActions: %u",
aForbidFutureRequests ? "yes" : "no", mUserActionMap.Count());
MOZ_ASSERT(!mForbidFutureRequests);
mForbidFutureRequests = mForbidFutureRequests | aForbidFutureRequests;
// Keys() iterates in-place and we will change the map so we need a copy.
for (const auto& userActionId :
mozilla::ToTArray<nsTArray<nsCString>>(mUserActionMap.Keys())) {
CancelRequestsByUserAction(userActionId);
}
// Again, Keys() iterates in-place and we change the map so we need a copy.
for (const auto& requestToken :
mozilla::ToTArray<nsTArray<nsCString>>(mWarnResponseDataMap.Keys())) {
LOGD(
"Responding to warn dialog (from CancelAllRequests) for "
"request %s",
requestToken.get());
RespondToWarnDialog(requestToken, false);
}
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysis::RespondToWarnDialog(const nsACString& aRequestToken,
bool aAllowContent) {
MOZ_ASSERT(NS_IsMainThread());
nsCString token(aRequestToken);
LOGD("Content analysis getting warn response %d for request %s",
aAllowContent ? 1 : 0, token.get());
auto entry = mWarnResponseDataMap.Extract(token);
if (!entry) {
LOGD(
"Content analysis request not found when trying to send warn "
"response for request %s",
token.get());
return NS_OK;
}
entry->mResponse->ResolveWarnAction(aAllowContent);
if (entry->mWasTimeout) {
LOGD(
"Warn response was for a previous timeout, inserting into "
"mUserActionIdToCanceledResponseMap for "
"userActionId %s",
entry->mUserActionId.get());
size_t count = 1;
auto userActionIdToCanceledResponseMap =
mUserActionIdToCanceledResponseMap.Lock();
if (auto maybeData =
userActionIdToCanceledResponseMap->Lookup(entry->mUserActionId)) {
count += maybeData->mNumExpectedResponses;
}
userActionIdToCanceledResponseMap->InsertOrUpdate(
entry->mUserActionId,
CanceledResponse{ConvertResult(entry->mResponse->GetAction()), count});
}
bool haveGottenResponse;
{
auto map = mRequestTokenToBasicRequestInfoMap.Lock();
haveGottenResponse = !map->Contains(aRequestToken);
}
// Don't acknowledge if we haven't gotten a response from the agent yet
IssueResponse(entry->mResponse, nsCString(entry->mUserActionId),
entry->mAutoAcknowledge && haveGottenResponse,
entry->mWasTimeout);
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysis::ShowBlockedRequestDialog(nsIContentAnalysisRequest* aRequest) {
RefPtr<mozilla::dom::WindowGlobalParent> windowGlobal;
MOZ_ALWAYS_SUCCEEDS(
aRequest->GetWindowGlobalParent(getter_AddRefs(windowGlobal)));
if (!windowGlobal) {
// Privileged context or gtest. Either way we show no dialog.
return NS_OK;
}
nsCString token;
MOZ_ALWAYS_SUCCEEDS(aRequest->GetRequestToken(token));
if (token.IsEmpty()) {
token = GenerateUUID();
aRequest->SetRequestToken(token);
}
nsCString userActionId;
MOZ_ALWAYS_SUCCEEDS(aRequest->GetUserActionId(userActionId));
if (userActionId.IsEmpty()) {
userActionId = GenerateUUID();
aRequest->SetUserActionId(userActionId);
}
nsCOMPtr<nsIObserverService> obsServ =
mozilla::services::GetObserverService();
obsServ->NotifyObservers(aRequest, "dlp-request-made", nullptr);
auto response = MakeRefPtr<ContentAnalysisResponse>(
nsIContentAnalysisResponse::Action::eBlock, std::move(token),
std::move(userActionId));
response->SetOwner(this);
obsServ->NotifyObservers(static_cast<nsIContentAnalysisResponse*>(response),
"dlp-response", nullptr);
return NS_OK;
}
#if defined(XP_WIN)
RefPtr<ContentAnalysis::PrintAllowedPromise>
ContentAnalysis::PrintToPDFToDetermineIfPrintAllowed(
dom::CanonicalBrowsingContext* aBrowsingContext,
nsIPrintSettings* aPrintSettings) {
if (!mozilla::StaticPrefs::
browser_contentanalysis_interception_point_print_enabled()) {
return PrintAllowedPromise::CreateAndResolve(PrintAllowedResult(true),
__func__);
}
// Note that the IsChrome() check here excludes a few
// common about pages like about:config, about:preferences,
// and about:support, but other about: pages may still
// go through content analysis.
if (aBrowsingContext->IsChrome()) {
return PrintAllowedPromise::CreateAndResolve(PrintAllowedResult(true),
__func__);
}
nsCOMPtr<nsIPrintSettings> contentAnalysisPrintSettings;
if (NS_WARN_IF(NS_FAILED(aPrintSettings->Clone(
getter_AddRefs(contentAnalysisPrintSettings)))) ||
NS_WARN_IF(!aBrowsingContext->GetCurrentWindowGlobal())) {
return PrintAllowedPromise::CreateAndReject(
PrintAllowedError(NS_ERROR_FAILURE), __func__);
}
contentAnalysisPrintSettings->SetOutputDestination(
nsIPrintSettings::OutputDestinationType::kOutputDestinationStream);
contentAnalysisPrintSettings->SetOutputFormat(
nsIPrintSettings::kOutputFormatPDF);
nsCOMPtr<nsIStorageStream> storageStream =
do_CreateInstance("@mozilla.org/storagestream;1");
if (!storageStream) {
return PrintAllowedPromise::CreateAndReject(
PrintAllowedError(NS_ERROR_FAILURE), __func__);
}
// Use segment size of 512K
nsresult rv = storageStream->Init(0x80000, UINT32_MAX);
if (NS_WARN_IF(NS_FAILED(rv))) {
return PrintAllowedPromise::CreateAndReject(PrintAllowedError(rv),
__func__);
}
nsCOMPtr<nsIOutputStream> outputStream;
storageStream->QueryInterface(NS_GET_IID(nsIOutputStream),
getter_AddRefs(outputStream));
MOZ_ASSERT(outputStream);
contentAnalysisPrintSettings->SetOutputStream(outputStream.get());
RefPtr<dom::CanonicalBrowsingContext> browsingContext = aBrowsingContext;
auto promise = MakeRefPtr<PrintAllowedPromise::Private>(__func__);
nsCOMPtr<nsIPrintSettings> finalPrintSettings(aPrintSettings);
aBrowsingContext
->PrintWithNoContentAnalysis(contentAnalysisPrintSettings, true, nullptr)
->Then(
GetCurrentSerialEventTarget(), __func__,
[browsingContext, contentAnalysisPrintSettings, finalPrintSettings,
promise](
dom::MaybeDiscardedBrowsingContext cachedStaticBrowsingContext)
MOZ_CAN_RUN_SCRIPT_BOUNDARY_LAMBDA mutable {
nsCOMPtr<nsIOutputStream> outputStream;
contentAnalysisPrintSettings->GetOutputStream(
getter_AddRefs(outputStream));
nsCOMPtr<nsIStorageStream> storageStream =
do_QueryInterface(outputStream);
MOZ_ASSERT(storageStream);
nsTArray<uint8_t> printData;
uint32_t length = 0;
storageStream->GetLength(&length);
if (!printData.SetLength(length, fallible)) {
promise->Reject(
PrintAllowedError(NS_ERROR_OUT_OF_MEMORY,
cachedStaticBrowsingContext),
__func__);
return;
}
nsCOMPtr<nsIInputStream> inputStream;
nsresult rv = storageStream->NewInputStream(
0, getter_AddRefs(inputStream));
if (NS_FAILED(rv)) {
promise->Reject(
PrintAllowedError(rv, cachedStaticBrowsingContext),
__func__);
return;
}
uint32_t currentPosition = 0;
while (currentPosition < length) {
uint32_t elementsRead = 0;
// Make sure the reinterpret_cast<> below is safe
static_assert(std::is_trivially_assignable_v<
decltype(*printData.Elements()), char>);
rv = inputStream->Read(
reinterpret_cast<char*>(printData.Elements()) +
currentPosition,
length - currentPosition, &elementsRead);
if (NS_WARN_IF(NS_FAILED(rv) || !elementsRead)) {
promise->Reject(
PrintAllowedError(NS_FAILED(rv) ? rv : NS_ERROR_FAILURE,
cachedStaticBrowsingContext),
__func__);
return;
}
currentPosition += elementsRead;
}
nsString printerName;
rv = contentAnalysisPrintSettings->GetPrinterName(printerName);
if (NS_WARN_IF(NS_FAILED(rv))) {
promise->Reject(
PrintAllowedError(rv, cachedStaticBrowsingContext),
__func__);
return;
}
auto* windowParent = browsingContext->GetCurrentWindowGlobal();
if (!windowParent) {
// The print window may have been closed by the user by now.
// Cancel the print.
promise->Reject(
PrintAllowedError(NS_ERROR_ABORT,
cachedStaticBrowsingContext),
__func__);
return;
}
nsCOMPtr<nsIURI> uri = GetURIForBrowsingContext(
windowParent->Canonical()->GetBrowsingContext());
if (!uri) {
promise->Reject(
PrintAllowedError(NS_ERROR_FAILURE,
cachedStaticBrowsingContext),
__func__);
return;
}
// It's a little unclear what we should pass to the agent if
// print.always_print_silent is true, because in that case we
// don't show the print preview dialog or the system print
// dialog.
//
// I'm thinking of the print preview dialog case as the "normal"
// one, so to me printing without a dialog is closer to the
// system print dialog case.
bool isFromPrintPreviewDialog =
!Preferences::GetBool("print.prefer_system_dialog") &&
!Preferences::GetBool("print.always_print_silent");
RefPtr<nsIContentAnalysisRequest> contentAnalysisRequest =
new contentanalysis::ContentAnalysisRequest(
std::move(printData), std::move(uri),
std::move(printerName),
isFromPrintPreviewDialog
? nsIContentAnalysisRequest::Reason::
ePrintPreviewPrint
: nsIContentAnalysisRequest::Reason::
eSystemDialogPrint,
windowParent);
auto callback =
MakeRefPtr<contentanalysis::ContentAnalysisCallback>(
[browsingContext, cachedStaticBrowsingContext, promise,
finalPrintSettings = std::move(finalPrintSettings)](
nsIContentAnalysisResult* aResult)
MOZ_CAN_RUN_SCRIPT_BOUNDARY_LAMBDA mutable {
promise->Resolve(
PrintAllowedResult(
aResult->GetShouldAllowContent(),
cachedStaticBrowsingContext),
__func__);
},
[promise,
cachedStaticBrowsingContext](nsresult aError) {
promise->Reject(
PrintAllowedError(aError,
cachedStaticBrowsingContext),
__func__);
});
nsCOMPtr<nsIContentAnalysis> contentAnalysis =
mozilla::components::nsIContentAnalysis::Service();
if (NS_WARN_IF(!contentAnalysis)) {
promise->Reject(
PrintAllowedError(rv, cachedStaticBrowsingContext),
__func__);
} else {
bool isActive = false;
nsresult rv = contentAnalysis->GetIsActive(&isActive);
// Should not be called if content analysis is not active
MOZ_ASSERT(isActive);
Unused << NS_WARN_IF(NS_FAILED(rv));
AutoTArray<RefPtr<nsIContentAnalysisRequest>, 1> requests{
contentAnalysisRequest};
rv = contentAnalysis->AnalyzeContentRequestsCallback(
requests, /* aAutoAcknowledge */ true, callback);
if (NS_WARN_IF(NS_FAILED(rv))) {
promise->Reject(
PrintAllowedError(rv, cachedStaticBrowsingContext),
__func__);
}
}
},
[promise](nsresult aError) {
promise->Reject(PrintAllowedError(aError), __func__);
});
return promise;
}
#endif
static nsresult CheckClipboard(
ContentAnalysisCallback* aCallback, Maybe<int32_t> aClipboardSequenceNumber,
bool aStoreInCache, nsITransferable* aTransferable,
mozilla::dom::WindowGlobalParent* aWindowGlobal,
mozilla::dom::WindowGlobalParent* aSourceWindowGlobal) {
NoContentAnalysisResult caResult =
NoContentAnalysisResult::DENY_DUE_TO_OTHER_ERROR;
auto respondOnFailure = MakeScopeExit([&]() {
LOGD("CheckClipboard skipping CA. Response = %d", (int)caResult);
RefPtr result = MakeRefPtr<ContentAnalysisNoResult>(caResult);
aCallback->ContentResult(result);
});
nsCOMPtr<nsIContentAnalysis> contentAnalysis =
mozilla::components::nsIContentAnalysis::Service();
if (!contentAnalysis) {
caResult = NoContentAnalysisResult::DENY_DUE_TO_OTHER_ERROR;
return NS_ERROR_NOT_AVAILABLE;
}
nsCOMPtr<nsIURI> uri =
aWindowGlobal ? ContentAnalysis::GetURIForBrowsingContext(
aWindowGlobal->Canonical()->GetBrowsingContext())
: nullptr;
auto request = MakeRefPtr<ContentAnalysisRequest>(
nsIContentAnalysisRequest::AnalysisType::eBulkDataEntry,
nsIContentAnalysisRequest::Reason::eClipboardPaste, aTransferable,
aWindowGlobal, aSourceWindowGlobal);
// Don't use the cache if the request can store to the cache -- that
// is an indication that this is a separate operation from the previous
// one.
if (!aStoreInCache && aClipboardSequenceNumber.isSome()) {
bool isValid = false;
nsIContentAnalysisResponse::Action action =
nsIContentAnalysisResponse::Action::eUnspecified;
contentAnalysis->GetCachedResponse(uri, *aClipboardSequenceNumber, &action,
&isValid);
if (isValid) {
LOGD("Content analysis returning cached clipboard response %d", action);
respondOnFailure.release();
RefPtr actionResult = MakeRefPtr<ContentAnalysisActionResult>(action);
if (!actionResult->GetShouldAllowContent()) {
contentAnalysis->ShowBlockedRequestDialog(request);
}
aCallback->ContentResult(actionResult);
return NS_OK;
}
}
RefPtr wrapperCallback = aCallback;
if (aStoreInCache && aClipboardSequenceNumber.isSome()) {
// Add the result to the result cache before we call the caller's callback.
wrapperCallback = MakeRefPtr<ContentAnalysisCallback>(
[aClipboardSequenceNumber, uri,
callback = RefPtr(aCallback)](nsIContentAnalysisResult* aResult) {
bool allow = aResult->GetShouldAllowContent();
nsCOMPtr<nsIContentAnalysis> contentAnalysis =
mozilla::components::nsIContentAnalysis::Service();
if (contentAnalysis) {
LOGD("Content analysis setting cached clipboard response: %s",
allow ? "allow" : "block");
contentAnalysis->SetCachedResponse(
uri, *aClipboardSequenceNumber,
allow ? nsIContentAnalysisResponse::Action::eAllow
: nsIContentAnalysisResponse::Action::eBlock);
}
callback->ContentResult(aResult);
},
[callback = RefPtr(aCallback)](nsresult rv) { callback->Error(rv); });
}
respondOnFailure.release();
AutoTArray<RefPtr<nsIContentAnalysisRequest>, 1> requests{request};
return contentAnalysis->AnalyzeContentRequestsCallback(
requests, true /* autoAcknowledge */, wrapperCallback);
}
// This method must stay in sync with ContentAnalysis::kKnownClipboardTypes. All
// of those types must be analyzed here, and if we start analyzing more types
// here we should add it to ContentAnalysis::kKnownClipboardTypes.
void ContentAnalysis::CheckClipboardContentAnalysis(
nsBaseClipboard* aClipboard, mozilla::dom::WindowGlobalParent* aWindow,
nsITransferable* aTransferable, nsIClipboard::ClipboardType aClipboardType,
ContentAnalysisCallback* aResolver, bool aForFullClipboard) {
// Make sure we call aResolver on error. Use the current value of
// noCAResult.
NoContentAnalysisResult noCAResult =
NoContentAnalysisResult::DENY_DUE_TO_OTHER_ERROR;
auto issueNoAnalysisResponse = MakeScopeExit([&]() {
LOGD("CheckClipboardContentAnalysis skipping CA. Response = %d",
(int)noCAResult);
auto result = MakeRefPtr<ContentAnalysisNoResult>(noCAResult);
aResolver->ContentResult(result);
});
nsCOMPtr<nsIContentAnalysis> contentAnalysis =
mozilla::components::nsIContentAnalysis::Service();
if (!contentAnalysis) {
noCAResult = NoContentAnalysisResult::DENY_DUE_TO_OTHER_ERROR;
return;
}
bool contentAnalysisIsActive;
nsresult rv = contentAnalysis->GetIsActive(&contentAnalysisIsActive);
if (MOZ_LIKELY(NS_FAILED(rv) || !contentAnalysisIsActive)) {
noCAResult =
NoContentAnalysisResult::ALLOW_DUE_TO_CONTENT_ANALYSIS_NOT_ACTIVE;
return;
}
mozilla::Maybe<uint64_t> cacheInnerWindowId =
aClipboard->GetClipboardCacheInnerWindowId(aClipboardType);
RefPtr<mozilla::dom::WindowGlobalParent> sourceWindowGlobal;
if (cacheInnerWindowId.isSome()) {
sourceWindowGlobal = mozilla::dom::WindowGlobalParent::GetByInnerWindowId(
*cacheInnerWindowId);
}
Maybe<int32_t> maybeSequenceNumber =
aClipboard->GetNativeClipboardSequenceNumber(aClipboardType)
.map<decltype(Some<int>)>(Some)
.unwrapOr(Nothing());
CheckClipboard(aResolver, maybeSequenceNumber, aForFullClipboard,
aTransferable, aWindow, sourceWindowGlobal);
issueNoAnalysisResponse.release();
}
bool ContentAnalysis::CheckClipboardContentAnalysisSync(
nsBaseClipboard* aClipboard, mozilla::dom::WindowGlobalParent* aWindow,
const nsCOMPtr<nsITransferable>& trans,
nsIClipboard::ClipboardType aClipboardType) {
bool requestDone = false;
bool result;
auto callback = MakeRefPtr<ContentAnalysisCallback>(
[&requestDone, &result](nsIContentAnalysisResult* aResult) {
result = aResult->GetShouldAllowContent();
requestDone = true;
});
CheckClipboardContentAnalysis(aClipboard, aWindow, trans, aClipboardType,
callback);
mozilla::SpinEventLoopUntil("CheckClipboardContentAnalysisSync"_ns,
[&requestDone]() -> bool { return requestDone; });
return result;
}
RefPtr<ContentAnalysis::FilesAllowedPromise>
ContentAnalysis::CheckUploadsInBatchMode(
nsCOMArray<nsIFile>&& aFiles, bool aAutoAcknowledge,
mozilla::dom::WindowGlobalParent* aWindow,
nsIContentAnalysisRequest::Reason aReason, nsIURI* aURI /* = nullptr */) {
nsresult rv;
auto contentAnalysis = GetContentAnalysisFromService();
// Ideally the caller would check all of this before going through the work
// of building up aFiles, but we'll double-check here.
if (NS_WARN_IF(!contentAnalysis)) {
return FilesAllowedPromise::CreateAndReject(rv, __func__);
}
bool contentAnalysisIsActive = false;
rv = contentAnalysis->GetIsActive(&contentAnalysisIsActive);
if (NS_WARN_IF(NS_FAILED(rv))) {
return FilesAllowedPromise::CreateAndReject(rv, __func__);
}
if (!contentAnalysisIsActive) {
return FilesAllowedPromise::CreateAndResolve(std::move(aFiles), __func__);
}
auto numberOfRequestsLeft = std::make_shared<size_t>(aFiles.Length());
auto allowedFiles = MakeRefPtr<media::Refcountable<nsCOMArray<nsIFile>>>();
auto userActionIds =
MakeRefPtr<media::Refcountable<mozilla::HashSet<nsCString>>>();
auto promise = MakeRefPtr<FilesAllowedPromise::Private>(__func__);
nsCOMPtr<nsIURI> uri;
if (aWindow) {
uri = aWindow->GetDocumentURI();
// Clients should only pass aURI if they're not passing aWindow.
MOZ_ASSERT(!aURI);
} else {
// Should only be used in tests
uri = aURI;
}
if (!contentAnalysis->mCompoundUserActions.put(userActionIds)) {
return FilesAllowedPromise::CreateAndReject(NS_ERROR_OUT_OF_MEMORY,
__func__);
}
auto cancelOnError = MakeScopeExit([&]() {
// Cancel one request to cancel the compound request.
if (!userActionIds->empty()) {
contentAnalysis->CancelRequestsByUserAction(userActionIds->iter().get());
}
});
for (auto* file : aFiles) {
#ifdef XP_WIN
nsString pathString(file->NativePath());
#else
nsString pathString = NS_ConvertUTF8toUTF16(file->NativePath());
#endif
RefPtr<nsIContentAnalysisRequest> request =
new mozilla::contentanalysis::ContentAnalysisRequest(
nsIContentAnalysisRequest::AnalysisType::eFileAttached, aReason,
pathString, true /* aStringIsFilePath */, EmptyCString(), uri,
nsIContentAnalysisRequest::OperationType::eUpload, aWindow);
nsCString userActionId = GenerateUUID();
MOZ_ALWAYS_SUCCEEDS(request->SetUserActionId(userActionId));
if (!userActionIds->put(userActionId)) {
return FilesAllowedPromise::CreateAndReject(NS_ERROR_OUT_OF_MEMORY,
__func__);
}
// For requests with the same userActionId, we multiply the timeout by the
// number of requests to make sure the agent has enough time to handle all
// of them. However, in this case we're using separate userActionIds for
// each of these files to get the batch mode behavior, so set a timeout
// multiplier to get the correct timeout.
//
// Note that this could theoretically be wrong, because if one of these
// files is actually a folder this could expand into many more requests, and
// using aFiles.Count() will undercount the total number of requests. But in
// practice, from the Windows file dialog users can only select multiple
// individual files that are not folders, or one single folder.
request->SetTimeoutMultiplier(static_cast<uint32_t>(aFiles.Count()));
nsTArray<RefPtr<nsIContentAnalysisRequest>> singleRequest{
std::move(request)};
auto callback =
mozilla::MakeRefPtr<mozilla::contentanalysis::ContentAnalysisCallback>(
// Note that this gets coerced to a std::function<>, which means it
// has to be copyable, so everything captured here must be copyable,
// which is why allowedFiles needs to be wrapped in a RefPtr and not
// simply std::move()d.
[promise, allowedFiles, numberOfRequestsLeft, file = RefPtr{file},
userActionIds](nsIContentAnalysisResult* aResult) {
// Since we're on the main thread, don't need to synchronize
// access to allowedFiles or numberOfRequestsLeft
AssertIsOnMainThread();
nsCOMPtr<nsIContentAnalysisResponse> response =
do_QueryInterface(aResult);
LOGD(
"Processing callback for batched file request, "
"numberOfRequestsLeft=%zu",
*(numberOfRequestsLeft.get()));
RefPtr<ContentAnalysis> owner = GetContentAnalysisFromService();
if (response && response->GetAction() ==
nsIContentAnalysisResponse::eCanceled) {
// This was cancelled, so even if some other files have been
// allowed we want to return an empty result.
LOGD("Batched file request got cancel response");
// Some of these may have finished already, but that's OK.
// Remove the userActionIds array, then cancel its entries, so
// that we only cancel them once.
if (owner) {
if (auto entry =
owner->mCompoundUserActions.lookup(userActionIds)) {
owner->mCompoundUserActions.remove(entry);
for (auto iter = userActionIds->iter(); !iter.done();
iter.next()) {
owner->CancelRequestsByUserAction(iter.get());
}
}
}
nsCOMArray<nsIFile> emptyFiles;
// Note that Resolve() will do nothing if the promise has
// already been resolved.
promise->Resolve(std::move(emptyFiles), __func__);
return;
}
if (aResult->GetShouldAllowContent()) {
allowedFiles->AppendElement(file);
}
(*numberOfRequestsLeft)--;
if (*numberOfRequestsLeft == 0) {
promise->Resolve(std::move(*allowedFiles), __func__);
if (owner) {
owner->mCompoundUserActions.remove(userActionIds);
}
}
},
[promise, userActionIds](nsresult aError) {
// cancel all requests
AssertIsOnMainThread();
LOGE("Batched file request got error %s",
SafeGetStaticErrorName(aError));
RefPtr<ContentAnalysis> owner = GetContentAnalysisFromService();
// Some of these may have finished already, but that's OK.
// Remove the userActionIds array, then cancel its entries, so
// that we only cancel these once.
if (owner) {
if (auto entry =
owner->mCompoundUserActions.lookup(userActionIds)) {
owner->mCompoundUserActions.remove(entry);
for (auto iter = userActionIds->iter(); !iter.done();
iter.next()) {
owner->CancelRequestsByUserAction(iter.get());
}
}
}
nsCOMArray<nsIFile> emptyFiles;
// Note that Resolve() will do nothing if the promise has already
// been resolved.
promise->Resolve(std::move(emptyFiles), __func__);
});
contentAnalysis->AnalyzeContentRequestsCallback(singleRequest,
aAutoAcknowledge, callback);
}
cancelOnError.release();
return promise;
}
NS_IMETHODIMP
ContentAnalysis::AnalyzeBatchContentRequest(nsIContentAnalysisRequest* aRequest,
bool aAutoAcknowledge,
JSContext* aCx,
mozilla::dom::Promise** aPromise) {
AssertIsOnMainThread();
// Get the ContentAnalysis service again to make this work with
// the mock service
nsCOMPtr<nsIContentAnalysis> contentAnalysis =
mozilla::components::nsIContentAnalysis::Service();
if (!contentAnalysis) {
return NS_ERROR_ILLEGAL_DURING_SHUTDOWN;
}
// Ideally the caller would check all of this before going through the work
// of building up aFiles, but we'll double-check here.
bool contentAnalysisIsActive = false;
nsresult rv = contentAnalysis->GetIsActive(&contentAnalysisIsActive);
if (NS_WARN_IF(NS_FAILED(rv))) {
return rv;
}
// Should not be called if content analysis is not active
MOZ_ASSERT(contentAnalysisIsActive);
if (!contentAnalysisIsActive) {
return NS_ERROR_NOT_AVAILABLE;
}
nsCOMPtr<dom::DataTransfer> dataTransfer;
rv = aRequest->GetDataTransfer(getter_AddRefs(dataTransfer));
NS_ENSURE_SUCCESS(rv, rv);
// This method expects dataTransfer to be present
MOZ_ASSERT(dataTransfer);
if (!dataTransfer) {
return NS_ERROR_FAILURE;
}
nsCOMArray<nsIFile> files;
auto& systemPrincipal = *nsContentUtils::GetSystemPrincipal();
if (dataTransfer->HasFile()) {
// Get any files in the DataTransfer and pass them to
// CheckUploadsInBatchMode() so they will be analyzed individually.
RefPtr fileList = dataTransfer->GetFiles(systemPrincipal);
files.SetCapacity(fileList->Length());
for (uint32_t i = 0; i < fileList->Length(); ++i) {
dom::File* file = fileList->Item(i);
if (!file) {
continue;
}
nsString filePath;
mozilla::ErrorResult result;
file->GetMozFullPathInternal(filePath, result);
if (NS_WARN_IF(result.Failed())) {
rv = result.StealNSResult();
return rv;
}
#ifdef XP_WIN
const nsString& nativePathString = filePath;
#else
nsCString nativePathString(NS_ConvertUTF16toUTF8(std::move(filePath)));
#endif
nsCOMPtr<nsIFile> nsFile;
rv = NS_NewPathStringLocalFile(nativePathString, getter_AddRefs(nsFile));
NS_ENSURE_SUCCESS(rv, rv);
files.AppendElement(nsFile);
}
}
RefPtr<mozilla::dom::Promise> filesPromise;
rv = MakePromise(aCx, getter_AddRefs(filesPromise));
NS_ENSURE_SUCCESS(rv, rv);
if (!files.IsEmpty()) {
RefPtr<mozilla::dom::WindowGlobalParent> windowGlobal;
MOZ_ALWAYS_SUCCEEDS(
aRequest->GetWindowGlobalParent(getter_AddRefs(windowGlobal)));
CheckUploadsInBatchMode(std::move(files), aAutoAcknowledge, windowGlobal,
nsIContentAnalysisRequest::Reason::eDragAndDrop)
->Then(
mozilla::GetMainThreadSerialEventTarget(), __func__,
[filesPromise,
request = RefPtr{aRequest}](nsCOMArray<nsIFile> aAllowedFiles) {
nsTArray<RefPtr<nsIFile>> allowedFiles;
allowedFiles.AppendElements(mozilla::Span(
aAllowedFiles.Elements(), aAllowedFiles.Length()));
filesPromise->MaybeResolve(std::move(allowedFiles));
},
[filesPromise](nsresult aError) {
filesPromise->MaybeReject(aError);
});
} else {
// Handle the case where there are files in fileList but
// all of them are null.
filesPromise->MaybeResolve(nsTArray<RefPtr<nsIFile>>());
}
RefPtr<dom::DataTransfer> transferWithoutFiles;
if (dataTransfer->HasFile()) {
rv = dataTransfer->Clone(
dataTransfer->GetParentObject(), dataTransfer->GetEventMessage(),
false /* aUserCancelled */, dataTransfer->IsCrossDomainSubFrameDrop(),
getter_AddRefs(transferWithoutFiles));
NS_ENSURE_SUCCESS(rv, rv);
transferWithoutFiles->SetMode(dom::DataTransfer::Mode::ReadWrite);
auto* items = transferWithoutFiles->Items();
if (items->Length() > 0) {
auto idx = items->Length();
do {
--idx;
bool found;
auto* item = items->IndexedGetter(idx, found);
MOZ_ASSERT(found);
if (item->Kind() == dom::DataTransferItem::KIND_FILE) {
items->Remove(idx, systemPrincipal, IgnoreErrors());
}
} while (idx);
}
} else {
// There were no files to begin with, so avoid cloning dataTransfer.
transferWithoutFiles = dataTransfer;
}
AutoTArray<RefPtr<dom::Promise>, 2> promises{filesPromise};
if (transferWithoutFiles->Items()->Length() > 0) {
RefPtr<ContentAnalysisRequest> requestWithoutFiles =
ContentAnalysisRequest::Clone(aRequest);
MOZ_ALWAYS_SUCCEEDS(
requestWithoutFiles->SetDataTransfer(transferWithoutFiles.get()));
AutoTArray<RefPtr<nsIContentAnalysisRequest>, 1> singleRequestWithoutFiles{
std::move(requestWithoutFiles)};
RefPtr<mozilla::dom::Promise> nonFilesPromise;
rv = contentAnalysis->AnalyzeContentRequests(
singleRequestWithoutFiles, aAutoAcknowledge, aCx,
getter_AddRefs(nonFilesPromise));
NS_ENSURE_SUCCESS(rv, NS_ERROR_FAILURE);
promises.AppendElement(nonFilesPromise);
}
ErrorResult errorResult;
RefPtr<dom::Promise> allPromise =
dom::Promise::All(aCx, promises, errorResult);
allPromise.forget(aPromise);
return errorResult.StealNSResult();
}
NS_IMETHODIMP
ContentAnalysisResponse::Acknowledge(
nsIContentAnalysisAcknowledgement* aAcknowledgement) {
MOZ_ASSERT(mOwner);
if (mHasAcknowledged) {
MOZ_ASSERT(false, "Already acknowledged this ContentAnalysisResponse!");
return NS_ERROR_FAILURE;
}
mHasAcknowledged = true;
if (mDoNotAcknowledge) {
return NS_OK;
}
return mOwner->RunAcknowledgeTask(aAcknowledgement, mRequestToken);
};
nsresult ContentAnalysis::RunAcknowledgeTask(
nsIContentAnalysisAcknowledgement* aAcknowledgement,
const nsACString& aRequestToken) {
bool isActive;
nsresult rv = GetIsActive(&isActive);
NS_ENSURE_SUCCESS(rv, rv);
if (!isActive) {
return NS_ERROR_NOT_AVAILABLE;
}
AssertIsOnMainThread();
content_analysis::sdk::ContentAnalysisAcknowledgement pbAck;
rv = ConvertToProtobuf(aAcknowledgement, aRequestToken, &pbAck);
NS_ENSURE_SUCCESS(rv, rv);
LOGD("Issuing ContentAnalysisAcknowledgement");
LogAcknowledgement(&pbAck);
nsCOMPtr<nsIObserverService> obsServ =
mozilla::services::GetObserverService();
// Do an early check here to avoid an extra dispatch to the main
// thread if no one is observing the message
bool rawMessageHasObserver =
obsServ->HasObservers("dlp-acknowledgement-sent-raw");
// The content analysis connection is synchronous so run in the background.
LOGD("RunAcknowledgeTask dispatching acknowledge task");
CallClientWithRetry<std::nullptr_t>(
__func__,
[pbAck = std::move(pbAck), rawMessageHasObserver](
std::shared_ptr<content_analysis::sdk::Client> client) mutable
-> Result<std::nullptr_t, nsresult> {
MOZ_ASSERT(!NS_IsMainThread());
RefPtr<ContentAnalysis> owner = GetContentAnalysisFromService();
if (!owner) {
// May be shutting down
return nullptr;
}
int err = client->Acknowledge(pbAck);
LOGD(
"RunAcknowledgeTask sent transaction acknowledgement, "
"err=%d",
err);
// Wait until the acknowledgement is sent before sending
// the dlp-acknowledgement-sent-raw notification to make tests
// more reliable.
if (rawMessageHasObserver) {
NS_DispatchToMainThread(NS_NewRunnableFunction(
__func__, [owner, pbAck = std::move(pbAck)]() {
nsCOMPtr<nsIObserverService> obsServ =
mozilla::services::GetObserverService();
std::string acknowledgementString = pbAck.SerializeAsString();
nsTArray<char16_t> acknowledgementArray;
acknowledgementArray.SetLength(acknowledgementString.size() +
1);
for (size_t i = 0; i < acknowledgementString.size(); ++i) {
// Since NotifyObservers() expects a null-terminated string,
// make sure none of these values are 0.
acknowledgementArray[i] = acknowledgementString[i] + 0xFF00;
}
acknowledgementArray[acknowledgementString.size()] = 0;
obsServ->NotifyObservers(
static_cast<nsIContentAnalysis*>(owner.get()),
"dlp-acknowledgement-sent-raw",
acknowledgementArray.Elements());
}));
}
if (err != 0) {
return Err(NS_ERROR_FAILURE);
}
return nullptr;
})
->Then(
GetMainThreadSerialEventTarget(), __func__, []() { /* do nothing */ },
[](nsresult rv) {
LOGE("RunAcknowledgeTask failed to get the client");
});
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysis::GetDiagnosticInfo(JSContext* aCx, dom::Promise** aPromise) {
RefPtr<dom::Promise> promise;
nsresult rv = MakePromise(aCx, getter_AddRefs(promise));
nsMainThreadPtrHandle<dom::Promise> promiseHolder(
new nsMainThreadPtrHolder<dom::Promise>(
"ContentAnalysis::GetDiagnosticInfo promise", promise));
NS_ENSURE_SUCCESS(rv, rv);
AssertIsOnMainThread();
CallClientWithRetry<std::nullptr_t>(
__func__,
[promiseHolder](
std::shared_ptr<content_analysis::sdk::Client> client) mutable
-> Result<std::nullptr_t, nsresult> {
MOZ_ASSERT(!NS_IsMainThread());
// I don't think this will be slow, but do it on the background thread
// just to be safe
std::string agentPath = client->GetAgentInfo().binary_path;
// Need to switch back to main thread to create the
// ContentAnalysisDiagnosticInfo and resolve the promise
NS_DispatchToMainThread(NS_NewRunnableFunction(
__func__, [promiseHolder = std::move(promiseHolder),
agentPath = std::move(agentPath)]() {
RefPtr<ContentAnalysis> self = GetContentAnalysisFromService();
if (!self) {
// may be quitting
promiseHolder->MaybeReject(NS_ERROR_ILLEGAL_DURING_SHUTDOWN);
return;
}
nsString agentWidePath = NS_ConvertUTF8toUTF16(agentPath);
// Note that if we made it here, we have successfully connected to
// the agent.
auto info = MakeRefPtr<ContentAnalysisDiagnosticInfo>(
/* mConnectedToAgent */ true, std::move(agentWidePath), false,
self ? self->mRequestCount : 0);
promiseHolder->MaybeResolve(info);
}));
return nullptr;
})
->Then(
GetMainThreadSerialEventTarget(), __func__, []() {},
[promiseHolder](nsresult rv) {
RefPtr<ContentAnalysis> self = GetContentAnalysisFromService();
auto info = MakeRefPtr<ContentAnalysisDiagnosticInfo>(
false, EmptyString(), rv == NS_ERROR_INVALID_SIGNATURE,
self ? self->mRequestCount : 0);
promiseHolder->MaybeResolve(info);
});
promise.forget(aPromise);
return NS_OK;
}
/* static */ nsCOMPtr<nsIURI> ContentAnalysis::GetURIForBrowsingContext(
dom::CanonicalBrowsingContext* aBrowsingContext) {
dom::WindowGlobalParent* windowGlobal =
aBrowsingContext->GetCurrentWindowGlobal();
if (!windowGlobal) {
return nullptr;
}
dom::CanonicalBrowsingContext* oldBrowsingContext = aBrowsingContext;
nsIPrincipal* principal = windowGlobal->DocumentPrincipal();
dom::CanonicalBrowsingContext* curBrowsingContext =
aBrowsingContext->GetParent();
while (curBrowsingContext) {
dom::WindowGlobalParent* newWindowGlobal =
curBrowsingContext->GetCurrentWindowGlobal();
if (!newWindowGlobal) {
break;
}
nsIPrincipal* newPrincipal = newWindowGlobal->DocumentPrincipal();
if (!(newPrincipal->Subsumes(principal))) {
break;
}
principal = newPrincipal;
oldBrowsingContext = curBrowsingContext;
curBrowsingContext = curBrowsingContext->GetParent();
}
if (nsContentUtils::IsPDFJS(principal)) {
// the principal's URI is the URI of the pdf.js reader
// so get the document's URI
dom::WindowContext* windowContext =
oldBrowsingContext->GetCurrentWindowContext();
if (!windowContext) {
return nullptr;
}
return windowContext->Canonical()->GetDocumentURI();
}
return principal->GetURI();
}
// IDL implementation
NS_IMETHODIMP ContentAnalysis::GetURIForBrowsingContext(
dom::BrowsingContext* aBrowsingContext, nsIURI** aURI) {
NS_ENSURE_ARG_POINTER(aBrowsingContext);
NS_ENSURE_ARG_POINTER(aURI);
nsCOMPtr<nsIURI> uri =
GetURIForBrowsingContext(aBrowsingContext->Canonical());
if (!uri) {
return NS_ERROR_FAILURE;
}
uri.forget(aURI);
return NS_OK;
}
NS_IMETHODIMP
ContentAnalysis::GetURIForDropEvent(dom::DragEvent* aEvent, nsIURI** aURI) {
MOZ_ASSERT(XRE_IsParentProcess());
*aURI = nullptr;
auto* widgetEvent = aEvent->WidgetEventPtr();
MOZ_ASSERT(widgetEvent);
MOZ_ASSERT(widgetEvent->mClass == eDragEventClass &&
widgetEvent->mMessage == eDrop);
auto* bp =
dom::BrowserParent::GetBrowserParentFromLayersId(widgetEvent->mLayersId);
NS_ENSURE_TRUE(bp, NS_ERROR_NOT_AVAILABLE);
auto* bc = bp->GetBrowsingContext();
NS_ENSURE_TRUE(bc, NS_ERROR_NO_CONTENT);
return GetURIForBrowsingContext(bc, aURI);
}
NS_IMETHODIMP ContentAnalysis::MakeResponseForTest(
nsIContentAnalysisResponse::Action aAction, const nsACString& aToken,
const nsACString& aUserActionId,
nsIContentAnalysisResponse** aNewResponse) {
auto response =
MakeRefPtr<ContentAnalysisResponse>(aAction, aToken, aUserActionId);
// Pretend this is not synthetic so dialogs will show in tests
response->SetIsSyntheticResponse(false);
response.forget(aNewResponse);
return NS_OK;
}
NS_IMETHODIMP ContentAnalysisCallback::ContentResult(
nsIContentAnalysisResult* aResult) {
LOGD("[%p] Called ContentAnalysisCallback::ContentResult", this);
// Grab a reference to the parameter.
RefPtr result = aResult;
if (mPromise) {
mPromise->MaybeResolve(aResult);
} else if (mContentResponseCallback) {
mContentResponseCallback(aResult);
} else {
MOZ_ASSERT_UNREACHABLE("ContentAnalysisCallback called multiple times");
}
ClearCallbacks();
return NS_OK;
}
NS_IMETHODIMP ContentAnalysisCallback::Error(nsresult aError) {
LOGD("[%p] Called ContentAnalysisCallback::Error", this);
if (mPromise) {
mPromise->MaybeReject(aError);
} else if (mErrorCallback) {
mErrorCallback(aError);
} else {
MOZ_ASSERT_UNREACHABLE("ContentAnalysisCallback called multiple times");
}
ClearCallbacks();
return NS_OK;
}
ContentAnalysisCallback::ContentAnalysisCallback(dom::Promise* aPromise)
: mPromise(aPromise) {}
ContentAnalysisCallback::ContentAnalysisCallback(
std::function<void(nsIContentAnalysisResult*)>&& aContentResponseCallback) {
mErrorCallback = [aContentResponseCallback](nsresult) {
RefPtr noResult = MakeRefPtr<ContentAnalysisNoResult>(
NoContentAnalysisResult::DENY_DUE_TO_OTHER_ERROR);
aContentResponseCallback(noResult);
};
mContentResponseCallback = std::move(aContentResponseCallback);
}
NS_IMETHODIMP ContentAnalysisDiagnosticInfo::GetConnectedToAgent(
bool* aConnectedToAgent) {
*aConnectedToAgent = mConnectedToAgent;
return NS_OK;
}
NS_IMETHODIMP ContentAnalysisDiagnosticInfo::GetAgentPath(
nsAString& aAgentPath) {
aAgentPath = mAgentPath;
return NS_OK;
}
NS_IMETHODIMP ContentAnalysisDiagnosticInfo::GetFailedSignatureVerification(
bool* aFailedSignatureVerification) {
*aFailedSignatureVerification = mFailedSignatureVerification;
return NS_OK;
}
NS_IMETHODIMP ContentAnalysisDiagnosticInfo::GetRequestCount(
int64_t* aRequestCount) {
*aRequestCount = mRequestCount;
return NS_OK;
}
#undef LOGD
#undef LOGE
} // namespace mozilla::contentanalysis
|