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 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952
|
/*
* Copyright (C) 2010 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.app.admin;
import static com.android.internal.util.function.pooled.PooledLambda.obtainMessage;
import android.Manifest.permission;
import android.annotation.CallbackExecutor;
import android.annotation.ColorInt;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.RequiresFeature;
import android.annotation.RequiresPermission;
import android.annotation.SdkConstant;
import android.annotation.SdkConstant.SdkConstantType;
import android.annotation.StringDef;
import android.annotation.SuppressLint;
import android.annotation.SystemApi;
import android.annotation.SystemService;
import android.annotation.TestApi;
import android.annotation.UnsupportedAppUsage;
import android.annotation.UserIdInt;
import android.annotation.WorkerThread;
import android.app.Activity;
import android.app.IServiceConnection;
import android.app.KeyguardManager;
import android.app.admin.SecurityLog.SecurityEvent;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.ServiceConnection;
import android.content.pm.ApplicationInfo;
import android.content.pm.IPackageDataObserver;
import android.content.pm.PackageManager;
import android.content.pm.PackageManager.NameNotFoundException;
import android.content.pm.ParceledListSlice;
import android.content.pm.UserInfo;
import android.graphics.Bitmap;
import android.net.NetworkUtils;
import android.net.PrivateDnsConnectivityChecker;
import android.net.ProxyInfo;
import android.net.Uri;
import android.os.Build;
import android.os.Bundle;
import android.os.ParcelFileDescriptor;
import android.os.Parcelable;
import android.os.PersistableBundle;
import android.os.Process;
import android.os.RemoteCallback;
import android.os.RemoteException;
import android.os.ServiceSpecificException;
import android.os.UserHandle;
import android.os.UserManager;
import android.os.UserManager.UserOperationException;
import android.os.UserManager.UserOperationResult;
import android.provider.CalendarContract;
import android.provider.ContactsContract.Directory;
import android.provider.Settings;
import android.security.AttestedKeyPair;
import android.security.Credentials;
import android.security.KeyChain;
import android.security.KeyChainException;
import android.security.keymaster.KeymasterCertificateChain;
import android.security.keystore.AttestationUtils;
import android.security.keystore.KeyAttestationException;
import android.security.keystore.KeyGenParameterSpec;
import android.security.keystore.ParcelableKeyGenParameterSpec;
import android.security.keystore.StrongBoxUnavailableException;
import android.service.restrictions.RestrictionsReceiver;
import android.telephony.TelephonyManager;
import android.telephony.data.ApnSetting;
import android.util.ArraySet;
import android.util.Log;
import com.android.internal.R;
import com.android.internal.annotations.VisibleForTesting;
import com.android.internal.os.BackgroundThread;
import com.android.internal.util.Preconditions;
import com.android.org.conscrypt.TrustedCertificateStore;
import java.io.ByteArrayInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.net.InetSocketAddress;
import java.net.Proxy;
import java.security.KeyFactory;
import java.security.KeyPair;
import java.security.NoSuchAlgorithmException;
import java.security.PrivateKey;
import java.security.cert.Certificate;
import java.security.cert.CertificateException;
import java.security.cert.CertificateFactory;
import java.security.cert.X509Certificate;
import java.security.spec.InvalidKeySpecException;
import java.security.spec.PKCS8EncodedKeySpec;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executor;
/**
* Public interface for managing policies enforced on a device. Most clients of this class must be
* registered with the system as a <a href="{@docRoot}guide/topics/admin/device-admin.html">device
* administrator</a>. Additionally, a device administrator may be registered as either a profile or
* device owner. A given method is accessible to all device administrators unless the documentation
* for that method specifies that it is restricted to either device or profile owners. Any
* application calling an api may only pass as an argument a device administrator component it
* owns. Otherwise, a {@link SecurityException} will be thrown.
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>
* For more information about managing policies for device administration, read the <a href=
* "{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer
* guide. </div>
*/
@SystemService(Context.DEVICE_POLICY_SERVICE)
@RequiresFeature(PackageManager.FEATURE_DEVICE_ADMIN)
public class DevicePolicyManager {
private static String TAG = "DevicePolicyManager";
private final Context mContext;
private final IDevicePolicyManager mService;
private final boolean mParentInstance;
/** @hide */
public DevicePolicyManager(Context context, IDevicePolicyManager service) {
this(context, service, false);
}
/** @hide */
@VisibleForTesting
protected DevicePolicyManager(Context context, IDevicePolicyManager service,
boolean parentInstance) {
mContext = context;
mService = service;
mParentInstance = parentInstance;
}
/** @hide test will override it. */
@VisibleForTesting
protected int myUserId() {
return mContext.getUserId();
}
/**
* Activity action: Starts the provisioning flow which sets up a managed profile.
*
* <p>A managed profile allows data separation for example for the usage of a
* device as a personal and corporate device. The user which provisioning is started from and
* the managed profile share a launcher.
*
* <p>This intent will typically be sent by a mobile device management application (MDM).
* Provisioning adds a managed profile and sets the MDM as the profile owner who has full
* control over the profile.
*
* <p>It is possible to check if provisioning is allowed or not by querying the method
* {@link #isProvisioningAllowed(String)}.
*
* <p>In version {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this intent must contain the
* extra {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}.
* As of {@link android.os.Build.VERSION_CODES#M}, it should contain the extra
* {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead, although specifying only
* {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported.
*
* <p>The intent may also contain the following extras:
* <ul>
* <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, optional </li>
* <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional, supported from
* {@link android.os.Build.VERSION_CODES#N}</li>
* <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_SKIP_USER_CONSENT}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_DISCLAIMERS}, optional</li>
* </ul>
*
* <p>When managed provisioning has completed, broadcasts are sent to the application specified
* in the provisioning intent. The
* {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast is sent in the
* managed profile and the {@link #ACTION_MANAGED_PROFILE_PROVISIONED} broadcast is sent in
* the primary profile.
*
* <p>From version {@link android.os.Build.VERSION_CODES#O}, when managed provisioning has
* completed, along with the above broadcast, activity intent
* {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the profile owner.
*
* <p>If provisioning fails, the managedProfile is removed so the device returns to its
* previous state.
*
* <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
* result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
* the provisioning flow was successful, although this doesn't guarantee the full flow will
* succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
* that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_PROVISION_MANAGED_PROFILE
= "android.app.action.PROVISION_MANAGED_PROFILE";
/**
* Activity action: Starts the provisioning flow which sets up a managed user.
*
* <p>This intent will typically be sent by a mobile device management application (MDM).
* Provisioning configures the user as managed user and sets the MDM as the profile
* owner who has full control over the user. Provisioning can only happen before user setup has
* been completed. Use {@link #isProvisioningAllowed(String)} to check if provisioning is
* allowed.
*
* <p>The intent contains the following extras:
* <ul>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
* <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
* </ul>
*
* <p>If provisioning fails, the device returns to its previous state.
*
* <p>If launched with {@link android.app.Activity#startActivityForResult(Intent, int)} a
* result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part of
* the provisioning flow was successful, although this doesn't guarantee the full flow will
* succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
* that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
*
* @hide
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_PROVISION_MANAGED_USER
= "android.app.action.PROVISION_MANAGED_USER";
/**
* Activity action: Starts the provisioning flow which sets up a managed device.
* Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
*
* <p> During device owner provisioning a device admin app is set as the owner of the device.
* A device owner has full control over the device. The device owner can not be modified by the
* user.
*
* <p> A typical use case would be a device that is owned by a company, but used by either an
* employee or client.
*
* <p> An intent with this action can be sent only on an unprovisioned device.
* It is possible to check if provisioning is allowed or not by querying the method
* {@link #isProvisioningAllowed(String)}.
*
* <p>The intent contains the following extras:
* <ul>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
* <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_DISCLAIMERS}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_SKIP_EDUCATION_SCREENS}, optional</li>
* </ul>
*
* <p>When device owner provisioning has completed, an intent of the type
* {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
* device owner.
*
* <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has
* completed, along with the above broadcast, activity intent
* {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner.
*
* <p>If provisioning fails, the device is factory reset.
*
* <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
* of the provisioning flow was successful, although this doesn't guarantee the full flow will
* succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
* that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_PROVISION_MANAGED_DEVICE
= "android.app.action.PROVISION_MANAGED_DEVICE";
/**
* Activity action: launch when user provisioning completed, i.e.
* {@link #getUserProvisioningState()} returns one of the complete state.
*
* <p> Please note that the API behavior is not necessarily consistent across various releases,
* and devices, as it's contract between SetupWizard and ManagedProvisioning. The default
* implementation is that ManagedProvisioning launches SetupWizard in NFC provisioning only.
*
* <p> The activity must be protected by permission
* {@link android.Manifest.permission#BIND_DEVICE_ADMIN}, and the process must hold
* {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE} to be launched.
* Only one {@link ComponentName} in the entire system should be enabled, and the rest of the
* components are not started by this intent.
* @hide
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
@SystemApi
public static final String ACTION_STATE_USER_SETUP_COMPLETE =
"android.app.action.STATE_USER_SETUP_COMPLETE";
/**
* Activity action: Starts the provisioning flow which sets up a managed device.
*
* <p>During device owner provisioning, a device admin app is downloaded and set as the owner of
* the device. A device owner has full control over the device. The device owner can not be
* modified by the user and the only way of resetting the device is via factory reset.
*
* <p>From version {@link android.os.Build.VERSION_CODES#Q}, the admin app can choose
* whether to set up a fully managed device or a work profile. For the admin app to support
* this, it must have an activity with intent filter {@link #ACTION_GET_PROVISIONING_MODE} and
* another one with intent filter {@link #ACTION_ADMIN_POLICY_COMPLIANCE}. For example:
* <pre>
* <activity
* android:name=".GetProvisioningModeActivity"
* android:label="@string/app_name"
* android:permission="android.permission.BIND_DEVICE_ADMIN">
* <intent-filter>
* <action
* android:name="android.app.action.GET_PROVISIONING_MODE" />
* <category android:name="android.intent.category.DEFAULT" />
* </intent-filter>
* </activity>
*
* <activity
* android:name=".PolicyComplianceActivity"
* android:label="@string/app_name"
* android:permission="android.permission.BIND_DEVICE_ADMIN">
* <intent-filter>
* <action
* android:name="android.app.action.ADMIN_POLICY_COMPLIANCE" />
* <category android:name="android.intent.category.DEFAULT" />
* </intent-filter>
* </activity></pre>
*
* <p>A typical use case would be a device that is owned by a company, but used by either an
* employee or client.
*
* <p>The provisioning message should be sent to an unprovisioned device.
*
* <p>Unlike {@link #ACTION_PROVISION_MANAGED_DEVICE}, the provisioning message can only be sent
* by a privileged app with the permission
* {@link android.Manifest.permission#DISPATCH_PROVISIONING_MESSAGE}.
*
* <p>The provisioning intent contains the following properties:
* <ul>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
* <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_SUPPORT_URL}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_ORGANIZATION_NAME}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_USE_MOBILE_DATA}, optional </li>
* <li>{@link #EXTRA_PROVISIONING_SKIP_EDUCATION_SCREENS}, optional - when not used for
* cloud enrollment, NFC or QR provisioning</li>
* </ul>
*
* @hide
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
@SystemApi
public static final String ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE =
"android.app.action.PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE";
/**
* Activity action: Starts the provisioning flow which sets up a managed device.
* Must be started with {@link android.app.Activity#startActivityForResult(Intent, int)}.
*
* <p>NOTE: This is only supported on split system user devices, and puts the device into a
* management state that is distinct from that reached by
* {@link #ACTION_PROVISION_MANAGED_DEVICE} - specifically the device owner runs on the system
* user, and only has control over device-wide policies, not individual users and their data.
* The primary benefit is that multiple non-system users are supported when provisioning using
* this form of device management.
*
* <p>During device owner provisioning a device admin app is set as the owner of the device.
* A device owner has full control over the device. The device owner can not be modified by the
* user.
*
* <p>A typical use case would be a device that is owned by a company, but used by either an
* employee or client.
*
* <p>An intent with this action can be sent only on an unprovisioned device.
* It is possible to check if provisioning is allowed or not by querying the method
* {@link #isProvisioningAllowed(String)}.
*
* <p>The intent contains the following extras:
* <ul>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}</li>
* <li>{@link #EXTRA_PROVISIONING_SKIP_ENCRYPTION}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LOGO_URI}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_MAIN_COLOR}, optional</li>
* </ul>
*
* <p>When device owner provisioning has completed, an intent of the type
* {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} is broadcast to the
* device owner.
*
* <p>From version {@link android.os.Build.VERSION_CODES#O}, when device owner provisioning has
* completed, along with the above broadcast, activity intent
* {@link #ACTION_PROVISIONING_SUCCESSFUL} will also be sent to the device owner.
*
* <p>If provisioning fails, the device is factory reset.
*
* <p>A result code of {@link android.app.Activity#RESULT_OK} implies that the synchronous part
* of the provisioning flow was successful, although this doesn't guarantee the full flow will
* succeed. Conversely a result code of {@link android.app.Activity#RESULT_CANCELED} implies
* that the user backed-out of provisioning, or some precondition for provisioning wasn't met.
*
* @hide
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE
= "android.app.action.PROVISION_MANAGED_SHAREABLE_DEVICE";
/**
* Activity action: Finalizes management provisioning, should be used after user-setup
* has been completed and {@link #getUserProvisioningState()} returns one of:
* <ul>
* <li>{@link #STATE_USER_SETUP_INCOMPLETE}</li>
* <li>{@link #STATE_USER_SETUP_COMPLETE}</li>
* <li>{@link #STATE_USER_PROFILE_COMPLETE}</li>
* </ul>
*
* @hide
*/
@SystemApi
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_PROVISION_FINALIZATION
= "android.app.action.PROVISION_FINALIZATION";
/**
* Action: Bugreport sharing with device owner has been accepted by the user.
*
* @hide
*/
public static final String ACTION_BUGREPORT_SHARING_ACCEPTED =
"com.android.server.action.REMOTE_BUGREPORT_SHARING_ACCEPTED";
/**
* Action: Bugreport sharing with device owner has been declined by the user.
*
* @hide
*/
public static final String ACTION_BUGREPORT_SHARING_DECLINED =
"com.android.server.action.REMOTE_BUGREPORT_SHARING_DECLINED";
/**
* Action: Bugreport has been collected and is dispatched to {@code DevicePolicyManagerService}.
*
* @hide
*/
public static final String ACTION_REMOTE_BUGREPORT_DISPATCH =
"android.intent.action.REMOTE_BUGREPORT_DISPATCH";
/**
* Extra for shared bugreport's SHA-256 hash.
*
* @hide
*/
public static final String EXTRA_REMOTE_BUGREPORT_HASH =
"android.intent.extra.REMOTE_BUGREPORT_HASH";
/**
* Extra for remote bugreport notification shown type.
*
* @hide
*/
public static final String EXTRA_BUGREPORT_NOTIFICATION_TYPE =
"android.app.extra.bugreport_notification_type";
/**
* Notification type for a started remote bugreport flow.
*
* @hide
*/
public static final int NOTIFICATION_BUGREPORT_STARTED = 1;
/**
* Notification type for a bugreport that has already been accepted to be shared, but is still
* being taken.
*
* @hide
*/
public static final int NOTIFICATION_BUGREPORT_ACCEPTED_NOT_FINISHED = 2;
/**
* Notification type for a bugreport that has been taken and can be shared or declined.
*
* @hide
*/
public static final int NOTIFICATION_BUGREPORT_FINISHED_NOT_ACCEPTED = 3;
/**
* Default and maximum timeout in milliseconds after which unlocking with weak auth times out,
* i.e. the user has to use a strong authentication method like password, PIN or pattern.
*
* @hide
*/
public static final long DEFAULT_STRONG_AUTH_TIMEOUT_MS = 72 * 60 * 60 * 1000; // 72h
/**
* A {@link android.os.Parcelable} extra of type {@link android.os.PersistableBundle} that
* allows a mobile device management application or NFC programmer application which starts
* managed provisioning to pass data to the management application instance after provisioning.
* <p>
* If used with {@link #ACTION_PROVISION_MANAGED_PROFILE} it can be used by the application that
* sends the intent to pass data to itself on the newly created profile.
* If used with {@link #ACTION_PROVISION_MANAGED_DEVICE} it allows passing data to the same
* instance of the app on the primary user.
* Starting from {@link android.os.Build.VERSION_CODES#M}, if used with
* {@link #MIME_TYPE_PROVISIONING_NFC} as part of NFC managed device provisioning, the NFC
* message should contain a stringified {@link java.util.Properties} instance, whose string
* properties will be converted into a {@link android.os.PersistableBundle} and passed to the
* management application after provisioning.
*
* <p>
* In both cases the application receives the data in
* {@link DeviceAdminReceiver#onProfileProvisioningComplete} via an intent with the action
* {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE}. The bundle is not changed
* during the managed provisioning.
*/
public static final String EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE =
"android.app.extra.PROVISIONING_ADMIN_EXTRAS_BUNDLE";
/**
* A String extra holding the package name of the mobile device management application that
* will be set as the profile owner or device owner.
*
* <p>If an application starts provisioning directly via an intent with action
* {@link #ACTION_PROVISION_MANAGED_PROFILE} this package has to match the package name of the
* application that started provisioning. The package will be set as profile owner in that case.
*
* <p>This package is set as device owner when device owner provisioning is started by an NFC
* message containing an NFC record with MIME type {@link #MIME_TYPE_PROVISIONING_NFC}.
*
* <p> When this extra is set, the application must have exactly one device admin receiver.
* This receiver will be set as the profile or device owner and active admin.
*
* @see DeviceAdminReceiver
* @deprecated Use {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME}. This extra is still
* supported, but only if there is only one device admin receiver in the package that requires
* the permission {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
*/
@Deprecated
public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME
= "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME";
/**
* A ComponentName extra indicating the device admin receiver of the mobile device management
* application that will be set as the profile owner or device owner and active admin.
*
* <p>If an application starts provisioning directly via an intent with action
* {@link #ACTION_PROVISION_MANAGED_PROFILE} or
* {@link #ACTION_PROVISION_MANAGED_DEVICE} the package name of this
* component has to match the package name of the application that started provisioning.
*
* <p>This component is set as device owner and active admin when device owner provisioning is
* started by an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or by an NFC
* message containing an NFC record with MIME type
* {@link #MIME_TYPE_PROVISIONING_NFC}. For the NFC record, the component name must be
* flattened to a string, via {@link ComponentName#flattenToShortString()}.
*
* @see DeviceAdminReceiver
*/
public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME
= "android.app.extra.PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME";
/**
* An {@link android.accounts.Account} extra holding the account to migrate during managed
* profile provisioning. If the account supplied is present in the primary user, it will be
* copied, along with its credentials to the managed profile and removed from the primary user.
*
* Use with {@link #ACTION_PROVISION_MANAGED_PROFILE}.
*/
public static final String EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE
= "android.app.extra.PROVISIONING_ACCOUNT_TO_MIGRATE";
/**
* Boolean extra to indicate that the migrated account should be kept. This is used in
* conjunction with {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}. If it's set to {@code true},
* the account will not be removed from the primary user after it is migrated to the newly
* created user or profile.
*
* <p> Defaults to {@code false}
*
* <p> Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} and
* {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}
*/
public static final String EXTRA_PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION
= "android.app.extra.PROVISIONING_KEEP_ACCOUNT_ON_MIGRATION";
/**
* @deprecated From {@link android.os.Build.VERSION_CODES#O}, never used while provisioning the
* device.
*/
@Deprecated
public static final String EXTRA_PROVISIONING_EMAIL_ADDRESS
= "android.app.extra.PROVISIONING_EMAIL_ADDRESS";
/**
* A integer extra indicating the predominant color to show during the provisioning.
* Refer to {@link android.graphics.Color} for how the color is represented.
*
* <p>Use with {@link #ACTION_PROVISION_MANAGED_PROFILE} or
* {@link #ACTION_PROVISION_MANAGED_DEVICE}.
*/
public static final String EXTRA_PROVISIONING_MAIN_COLOR =
"android.app.extra.PROVISIONING_MAIN_COLOR";
/**
* A Boolean extra that can be used by the mobile device management application to skip the
* disabling of system apps during provisioning when set to {@code true}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
* {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
*/
public static final String EXTRA_PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED =
"android.app.extra.PROVISIONING_LEAVE_ALL_SYSTEM_APPS_ENABLED";
/**
* A String extra holding the time zone {@link android.app.AlarmManager} that the device
* will be set to.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_TIME_ZONE
= "android.app.extra.PROVISIONING_TIME_ZONE";
/**
* A Long extra holding the wall clock time (in milliseconds) to be set on the device's
* {@link android.app.AlarmManager}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_LOCAL_TIME
= "android.app.extra.PROVISIONING_LOCAL_TIME";
/**
* A String extra holding the {@link java.util.Locale} that the device will be set to.
* Format: xx_yy, where xx is the language code, and yy the country code.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_LOCALE
= "android.app.extra.PROVISIONING_LOCALE";
/**
* A String extra holding the ssid of the wifi network that should be used during nfc device
* owner provisioning for downloading the mobile device management application.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_WIFI_SSID
= "android.app.extra.PROVISIONING_WIFI_SSID";
/**
* A boolean extra indicating whether the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
* is hidden or not.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_WIFI_HIDDEN
= "android.app.extra.PROVISIONING_WIFI_HIDDEN";
/**
* A String extra indicating the security type of the wifi network in
* {@link #EXTRA_PROVISIONING_WIFI_SSID} and could be one of {@code NONE}, {@code WPA},
* {@code WEP} or {@code EAP}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_WIFI_SECURITY_TYPE
= "android.app.extra.PROVISIONING_WIFI_SECURITY_TYPE";
/**
* A String extra holding the password of the wifi network in
* {@link #EXTRA_PROVISIONING_WIFI_SSID}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_WIFI_PASSWORD =
"android.app.extra.PROVISIONING_WIFI_PASSWORD";
/**
* The EAP method of the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
* and could be one of {@code PEAP}, {@code TLS}, {@code TTLS}, {@code PWD}, {@code SIM},
* {@code AKA} or {@code AKA_PRIME}. This is only used if the
* {@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE} is {@code EAP}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump. It can also be used for QR code provisioning.
*/
public static final String EXTRA_PROVISIONING_WIFI_EAP_METHOD =
"android.app.extra.PROVISIONING_WIFI_EAP_METHOD";
/**
* The phase 2 authentication of the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}
* and could be one of {@code NONE}, {@code PAP}, {@code MSCHAP}, {@code MSCHAPV2}, {@code GTC},
* {@code SIM}, {@code AKA} or {@code AKA_PRIME}. This is only used if the
* {@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE} is {@code EAP}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump. It can also be used for QR code provisioning.
*/
public static final String EXTRA_PROVISIONING_WIFI_PHASE2_AUTH =
"android.app.extra.PROVISIONING_WIFI_PHASE2_AUTH";
/**
* The CA certificate of the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}. This should
* be an X.509 certificate Base64 encoded DER format, ie. PEM representation of a certificate
* without header, footer and line breaks. <a href=
* "https://tools.ietf.org/html/rfc7468"> More information</a> This is only
* used if the {@link
* #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE} is {@code EAP}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump. It can also be used for QR code provisioning.
*/
public static final String EXTRA_PROVISIONING_WIFI_CA_CERTIFICATE =
"android.app.extra.PROVISIONING_WIFI_CA_CERTIFICATE";
/**
* The user certificate of the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}. This
* should be an X.509 certificate and private key Base64 encoded DER format, ie. PEM
* representation of a certificate and key without header, footer and line breaks. <a href=
* "https://tools.ietf.org/html/rfc7468"> More information</a> This is only
* used if the {@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE} is {@code EAP}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump. It can also be used for QR code provisioning.
*/
public static final String EXTRA_PROVISIONING_WIFI_USER_CERTIFICATE =
"android.app.extra.PROVISIONING_WIFI_USER_CERTIFICATE";
/**
* The identity of the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}. This is only used
* if the {@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE} is {@code EAP}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump. It can also be used for QR code provisioning.
*/
public static final String EXTRA_PROVISIONING_WIFI_IDENTITY =
"android.app.extra.PROVISIONING_WIFI_IDENTITY";
/**
* The anonymous identity of the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}. This is
* only used if the {@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE} is {@code EAP}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump. It can also be used for QR code provisioning.
*/
public static final String EXTRA_PROVISIONING_WIFI_ANONYMOUS_IDENTITY =
"android.app.extra.PROVISIONING_WIFI_ANONYMOUS_IDENTITY";
/**
* The domain of the wifi network in {@link #EXTRA_PROVISIONING_WIFI_SSID}. This is only used if
* the {@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE} is {@code EAP}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump. It can also be used for QR code provisioning.
*/
public static final String EXTRA_PROVISIONING_WIFI_DOMAIN =
"android.app.extra.PROVISIONING_WIFI_DOMAIN";
/**
* A String extra holding the proxy host for the wifi network in
* {@link #EXTRA_PROVISIONING_WIFI_SSID}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_WIFI_PROXY_HOST
= "android.app.extra.PROVISIONING_WIFI_PROXY_HOST";
/**
* An int extra holding the proxy port for the wifi network in
* {@link #EXTRA_PROVISIONING_WIFI_SSID}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_WIFI_PROXY_PORT
= "android.app.extra.PROVISIONING_WIFI_PROXY_PORT";
/**
* A String extra holding the proxy bypass for the wifi network in
* {@link #EXTRA_PROVISIONING_WIFI_SSID}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_WIFI_PROXY_BYPASS
= "android.app.extra.PROVISIONING_WIFI_PROXY_BYPASS";
/**
* A String extra holding the proxy auto-config (PAC) URL for the wifi network in
* {@link #EXTRA_PROVISIONING_WIFI_SSID}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_WIFI_PAC_URL
= "android.app.extra.PROVISIONING_WIFI_PAC_URL";
/**
* A String extra holding a url that specifies the download location of the device admin
* package. When not provided it is assumed that the device admin package is already installed.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION
= "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION";
/**
* A String extra holding the localized name of the organization under management.
*
* The name is displayed only during provisioning.
*
* <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
*
* @hide
*/
@SystemApi
public static final String EXTRA_PROVISIONING_ORGANIZATION_NAME =
"android.app.extra.PROVISIONING_ORGANIZATION_NAME";
/**
* A String extra holding a url to the website of the device provider so the user can open it
* during provisioning. If the url is not HTTPS, an error will be shown.
*
* <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
*
* @hide
*/
@SystemApi
public static final String EXTRA_PROVISIONING_SUPPORT_URL =
"android.app.extra.PROVISIONING_SUPPORT_URL";
/**
* A String extra holding the localized name of the device admin package. It should be the same
* as the app label of the package.
*
* <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
*
* @hide
*/
@SystemApi
public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL =
"android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_LABEL";
/**
* A {@link Uri} extra pointing to the app icon of device admin package. This image will be
* shown during the provisioning.
* <h5>The following URI schemes are accepted:</h5>
* <ul>
* <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
* <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
* </ul>
*
* <p> It is the responsibility of the caller to provide an image with a reasonable
* pixel density for the device.
*
* <p> If a content: URI is passed, the intent should have the flag
* {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
* {@link android.content.ClipData} of the intent too.
*
* <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}
*
* @hide
*/
@SystemApi
public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI =
"android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_ICON_URI";
/**
* An int extra holding a minimum required version code for the device admin package. If the
* device admin is already installed on the device, it will only be re-downloaded from
* {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION} if the version of the
* installed package is less than this version code.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE
= "android.app.extra.PROVISIONING_DEVICE_ADMIN_MINIMUM_VERSION_CODE";
/**
* A String extra holding a http cookie header which should be used in the http request to the
* url specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER
= "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER";
/**
* A String extra holding the URL-safe base64 encoded SHA-256 hash of the file at download
* location specified in {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
*
* <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM} must be
* present. The provided checksum must match the checksum of the file at the download
* location. If the checksum doesn't match an error will be shown to the user and the user will
* be asked to factory reset the device.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*
* <p><strong>Note:</strong> for devices running {@link android.os.Build.VERSION_CODES#LOLLIPOP}
* and {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1} only SHA-1 hash is supported.
* Starting from {@link android.os.Build.VERSION_CODES#M}, this parameter accepts SHA-256 in
* addition to SHA-1. From {@link android.os.Build.VERSION_CODES#Q}, only SHA-256 hash is
* supported.
*/
public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM
= "android.app.extra.PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM";
/**
* A String extra holding the URL-safe base64 encoded SHA-256 checksum of any signature of the
* android package archive at the download location specified in {@link
* #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}.
*
* <p>The signatures of an android package archive can be obtained using
* {@link android.content.pm.PackageManager#getPackageArchiveInfo} with flag
* {@link android.content.pm.PackageManager#GET_SIGNATURES}.
*
* <p>Either this extra or {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM} must be
* present. The provided checksum must match the checksum of any signature of the file at
* the download location. If the checksum does not match an error will be shown to the user and
* the user will be asked to factory reset the device.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*/
public static final String EXTRA_PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM
= "android.app.extra.PROVISIONING_DEVICE_ADMIN_SIGNATURE_CHECKSUM";
/**
* Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile
* has completed successfully.
*
* <p>The broadcast is limited to the primary profile, to the app specified in the provisioning
* intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
*
* <p>This intent will contain the following extras
* <ul>
* <li>{@link Intent#EXTRA_USER}, corresponds to the {@link UserHandle} of the managed
* profile.</li>
* <li>{@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE}, corresponds to the account requested to
* be migrated at provisioning time, if any.</li>
* </ul>
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_MANAGED_PROFILE_PROVISIONED
= "android.app.action.MANAGED_PROFILE_PROVISIONED";
/**
* Activity action: This activity action is sent to indicate that provisioning of a managed
* profile or managed device has completed successfully. It'll be sent at the same time as
* {@link DeviceAdminReceiver#ACTION_PROFILE_PROVISIONING_COMPLETE} broadcast but this will be
* delivered faster as it's an activity intent.
*
* <p>The intent is only sent to the new device or profile owner.
*
* @see #ACTION_PROVISION_MANAGED_PROFILE
* @see #ACTION_PROVISION_MANAGED_DEVICE
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_PROVISIONING_SUCCESSFUL =
"android.app.action.PROVISIONING_SUCCESSFUL";
/**
* A boolean extra indicating whether device encryption can be skipped as part of device owner
* or managed profile provisioning.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} or an intent with action
* {@link #ACTION_PROVISION_MANAGED_DEVICE} that starts device owner provisioning.
*
* <p>From {@link android.os.Build.VERSION_CODES#N} onwards, this is also supported for an
* intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE}.
*/
public static final String EXTRA_PROVISIONING_SKIP_ENCRYPTION =
"android.app.extra.PROVISIONING_SKIP_ENCRYPTION";
/**
* A {@link Uri} extra pointing to a logo image. This image will be shown during the
* provisioning. If this extra is not passed, a default image will be shown.
* <h5>The following URI schemes are accepted:</h5>
* <ul>
* <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
* <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
* </ul>
*
* <p> It is the responsibility of the caller to provide an image with a reasonable
* pixel density for the device.
*
* <p> If a content: URI is passed, the intent should have the flag
* {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
* {@link android.content.ClipData} of the intent too.
*
* <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
* {@link #ACTION_PROVISION_MANAGED_DEVICE}
*/
public static final String EXTRA_PROVISIONING_LOGO_URI =
"android.app.extra.PROVISIONING_LOGO_URI";
/**
* A {@link Bundle}[] extra consisting of list of disclaimer headers and disclaimer contents.
* Each {@link Bundle} must have both {@link #EXTRA_PROVISIONING_DISCLAIMER_HEADER}
* as disclaimer header, and {@link #EXTRA_PROVISIONING_DISCLAIMER_CONTENT} as disclaimer
* content.
*
* <p> The extra typically contains one disclaimer from the company of mobile device
* management application (MDM), and one disclaimer from the organization.
*
* <p> Call {@link Bundle#putParcelableArray(String, Parcelable[])} to put the {@link Bundle}[]
*
* <p> Maximum 3 key-value pairs can be specified. The rest will be ignored.
*
* <p> Use in an intent with action {@link #ACTION_PROVISION_MANAGED_PROFILE} or
* {@link #ACTION_PROVISION_MANAGED_DEVICE}
*/
public static final String EXTRA_PROVISIONING_DISCLAIMERS =
"android.app.extra.PROVISIONING_DISCLAIMERS";
/**
* A String extra of localized disclaimer header.
*
* <p> The extra is typically the company name of mobile device management application (MDM)
* or the organization name.
*
* <p> Use in Bundle {@link #EXTRA_PROVISIONING_DISCLAIMERS}
*
* <p> System app, i.e. application with {@link ApplicationInfo#FLAG_SYSTEM}, can also insert a
* disclaimer by declaring an application-level meta-data in {@code AndroidManifest.xml}.
* Must use it with {@link #EXTRA_PROVISIONING_DISCLAIMER_CONTENT}. Here is the example:
*
* <pre>
* <meta-data
* android:name="android.app.extra.PROVISIONING_DISCLAIMER_HEADER"
* android:resource="@string/disclaimer_header"
* /></pre>
*/
public static final String EXTRA_PROVISIONING_DISCLAIMER_HEADER =
"android.app.extra.PROVISIONING_DISCLAIMER_HEADER";
/**
* A {@link Uri} extra pointing to disclaimer content.
*
* <h5>The following URI schemes are accepted:</h5>
* <ul>
* <li>content ({@link android.content.ContentResolver#SCHEME_CONTENT})</li>
* <li>android.resource ({@link android.content.ContentResolver#SCHEME_ANDROID_RESOURCE})</li>
* </ul>
*
* <p> Styled text is supported in the disclaimer content. The content is parsed by
* {@link android.text.Html#fromHtml(String)} and displayed in a
* {@link android.widget.TextView}.
*
* <p> If a <code>content:</code> URI is passed, URI is passed, the intent should have the flag
* {@link Intent#FLAG_GRANT_READ_URI_PERMISSION} and the uri should be added to the
* {@link android.content.ClipData} of the intent too.
*
* <p> Use in Bundle {@link #EXTRA_PROVISIONING_DISCLAIMERS}
*
* <p> System app, i.e. application with {@link ApplicationInfo#FLAG_SYSTEM}, can also insert a
* disclaimer by declaring an application-level meta-data in {@code AndroidManifest.xml}.
* Must use it with {@link #EXTRA_PROVISIONING_DISCLAIMER_HEADER}. Here is the example:
*
* <pre>
* <meta-data
* android:name="android.app.extra.PROVISIONING_DISCLAIMER_CONTENT"
* android:resource="@string/disclaimer_content"
* /></pre>
*/
public static final String EXTRA_PROVISIONING_DISCLAIMER_CONTENT =
"android.app.extra.PROVISIONING_DISCLAIMER_CONTENT";
/**
* A boolean extra indicating if user setup should be skipped, for when provisioning is started
* during setup-wizard.
*
* <p>If unspecified, defaults to {@code true} to match the behavior in
* {@link android.os.Build.VERSION_CODES#M} and earlier.
*
* <p>Use in an intent with action {@link #ACTION_PROVISION_MANAGED_DEVICE} or
* {@link #ACTION_PROVISION_MANAGED_USER}.
*
* @hide
*/
public static final String EXTRA_PROVISIONING_SKIP_USER_SETUP =
"android.app.extra.PROVISIONING_SKIP_USER_SETUP";
/**
* A boolean extra indicating if the user consent steps from the provisioning flow should be
* skipped. If unspecified, defaults to {@code false}.
*
* It can only be used by an existing device owner trying to create a managed profile via
* {@link #ACTION_PROVISION_MANAGED_PROFILE}. Otherwise it is ignored.
*/
public static final String EXTRA_PROVISIONING_SKIP_USER_CONSENT =
"android.app.extra.PROVISIONING_SKIP_USER_CONSENT";
/**
* A boolean extra indicating if the education screens from the provisioning flow should be
* skipped. If unspecified, defaults to {@code false}.
*
* <p>This extra can be set in the following ways:
* <ul>
* <li>By the admin app when performing the admin-integrated
* provisioning flow as a result of the {@link #ACTION_GET_PROVISIONING_MODE} activity</li>
* <li>With intent action {@link #ACTION_PROVISION_MANAGED_DEVICE}</li>
* </ul>
*
* <p>If the education screens are skipped, it is the admin application's responsibility
* to display its own user education screens.
*/
public static final String EXTRA_PROVISIONING_SKIP_EDUCATION_SCREENS =
"android.app.extra.PROVISIONING_SKIP_EDUCATION_SCREENS";
/**
* A boolean extra indicating if mobile data should be used during NFC device owner provisioning
* for downloading the mobile device management application. If {@link
* #EXTRA_PROVISIONING_WIFI_SSID} is also specified, wifi network will be used instead.
*
* <p>Use in an NFC record with {@link #MIME_TYPE_PROVISIONING_NFC} that starts device owner
* provisioning via an NFC bump.
*
* @hide
*/
public static final String EXTRA_PROVISIONING_USE_MOBILE_DATA =
"android.app.extra.PROVISIONING_USE_MOBILE_DATA";
/**
* A String extra holding the provisioning trigger. It could be one of
* {@link #PROVISIONING_TRIGGER_CLOUD_ENROLLMENT}, {@link #PROVISIONING_TRIGGER_QR_CODE},
* {@link #PROVISIONING_TRIGGER_PERSISTENT_DEVICE_OWNER} or {@link
* #PROVISIONING_TRIGGER_UNSPECIFIED}.
*
* <p>Use in an intent with action {@link
* #ACTION_PROVISION_MANAGED_DEVICE_FROM_TRUSTED_SOURCE}.
* @hide
*/
@SystemApi
public static final String EXTRA_PROVISIONING_TRIGGER =
"android.app.extra.PROVISIONING_TRIGGER";
/**
* A value for {@link #EXTRA_PROVISIONING_TRIGGER} indicating that the provisioning
* trigger has not been specified.
* @see #PROVISIONING_TRIGGER_CLOUD_ENROLLMENT
* @see #PROVISIONING_TRIGGER_QR_CODE
* @see #PROVISIONING_TRIGGER_PERSISTENT_DEVICE_OWNER
* @hide
*/
@SystemApi
public static final int PROVISIONING_TRIGGER_UNSPECIFIED = 0;
/**
* A value for {@link #EXTRA_PROVISIONING_TRIGGER} indicating that the provisioning
* trigger is cloud enrollment.
* @see #PROVISIONING_TRIGGER_QR_CODE
* @see #PROVISIONING_TRIGGER_PERSISTENT_DEVICE_OWNER
* @see #PROVISIONING_TRIGGER_UNSPECIFIED
* @hide
*/
@SystemApi
public static final int PROVISIONING_TRIGGER_CLOUD_ENROLLMENT = 1;
/**
* A value for {@link #EXTRA_PROVISIONING_TRIGGER} indicating that the provisioning
* trigger is the QR code scanner.
* @see #PROVISIONING_TRIGGER_CLOUD_ENROLLMENT
* @see #PROVISIONING_TRIGGER_PERSISTENT_DEVICE_OWNER
* @see #PROVISIONING_TRIGGER_UNSPECIFIED
* @hide
*/
@SystemApi
public static final int PROVISIONING_TRIGGER_QR_CODE = 2;
/**
* A value for {@link #EXTRA_PROVISIONING_TRIGGER} indicating that the provisioning
* trigger is persistent device owner enrollment.
* @see #PROVISIONING_TRIGGER_CLOUD_ENROLLMENT
* @see #PROVISIONING_TRIGGER_QR_CODE
* @see #PROVISIONING_TRIGGER_UNSPECIFIED
* @hide
*/
@SystemApi
public static final int PROVISIONING_TRIGGER_PERSISTENT_DEVICE_OWNER = 3;
/**
* This MIME type is used for starting the device owner provisioning.
*
* <p>During device owner provisioning a device admin app is set as the owner of the device.
* A device owner has full control over the device. The device owner can not be modified by the
* user and the only way of resetting the device is if the device owner app calls a factory
* reset.
*
* <p> A typical use case would be a device that is owned by a company, but used by either an
* employee or client.
*
* <p> The NFC message must be sent to an unprovisioned device.
*
* <p>The NFC record must contain a serialized {@link java.util.Properties} object which
* contains the following properties:
* <ul>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}</li>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_LOCATION}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_DOWNLOAD_COOKIE_HEADER}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_CHECKSUM}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LOCAL_TIME} (convert to String), optional</li>
* <li>{@link #EXTRA_PROVISIONING_TIME_ZONE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_LOCALE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_SSID}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_HIDDEN} (convert to String), optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_SECURITY_TYPE}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PASSWORD}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_HOST}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_PORT} (convert to String), optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PROXY_BYPASS}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PAC_URL}, optional</li>
* <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}, optional, supported from {@link
* android.os.Build.VERSION_CODES#M} </li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_EAP_METHOD}, optional, supported from {@link
* android.os.Build.VERSION_CODES#Q}</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_PHASE2_AUTH}, optional, supported from {@link
* android.os.Build.VERSION_CODES#Q}</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_CA_CERTIFICATE}, optional, supported from {@link
* android.os.Build.VERSION_CODES#Q}</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_USER_CERTIFICATE}, optional, supported from {@link
* android.os.Build.VERSION_CODES#Q}</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_IDENTITY}, optional, supported from {@link
* android.os.Build.VERSION_CODES#Q}</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_ANONYMOUS_IDENTITY}, optional, supported from {@link
* android.os.Build.VERSION_CODES#Q}</li>
* <li>{@link #EXTRA_PROVISIONING_WIFI_DOMAIN}, optional, supported from {@link
* android.os.Build.VERSION_CODES#Q}</li></ul>
*
* <p>
* As of {@link android.os.Build.VERSION_CODES#M}, the properties should contain
* {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_COMPONENT_NAME} instead of
* {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME}, (although specifying only
* {@link #EXTRA_PROVISIONING_DEVICE_ADMIN_PACKAGE_NAME} is still supported).
*/
public static final String MIME_TYPE_PROVISIONING_NFC
= "application/com.android.managedprovisioning";
/**
* Activity action: ask the user to add a new device administrator to the system.
* The desired policy is the ComponentName of the policy in the
* {@link #EXTRA_DEVICE_ADMIN} extra field. This will invoke a UI to
* bring the user through adding the device administrator to the system (or
* allowing them to reject it).
*
* <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
* field to provide the user with additional explanation (in addition
* to your component's description) about what is being added.
*
* <p>If your administrator is already active, this will ordinarily return immediately (without
* user intervention). However, if your administrator has been updated and is requesting
* additional uses-policy flags, the user will be presented with the new list. New policies
* will not be available to the updated administrator until the user has accepted the new list.
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_ADD_DEVICE_ADMIN
= "android.app.action.ADD_DEVICE_ADMIN";
/**
* @hide
* Activity action: ask the user to add a new device administrator as the profile owner
* for this user. Only system apps can launch this intent.
*
* <p>The ComponentName of the profile owner admin is passed in the {@link #EXTRA_DEVICE_ADMIN}
* extra field. This will invoke a UI to bring the user through adding the profile owner admin
* to remotely control restrictions on the user.
*
* <p>The intent must be invoked via {@link Activity#startActivityForResult} to receive the
* result of whether or not the user approved the action. If approved, the result will
* be {@link Activity#RESULT_OK} and the component will be set as an active admin as well
* as a profile owner.
*
* <p>You can optionally include the {@link #EXTRA_ADD_EXPLANATION}
* field to provide the user with additional explanation (in addition
* to your component's description) about what is being added.
*
* <p>If there is already a profile owner active or the caller is not a system app, the
* operation will return a failure result.
*/
@SystemApi
public static final String ACTION_SET_PROFILE_OWNER
= "android.app.action.SET_PROFILE_OWNER";
/**
* @hide
* Name of the profile owner admin that controls the user.
*/
@SystemApi
public static final String EXTRA_PROFILE_OWNER_NAME
= "android.app.extra.PROFILE_OWNER_NAME";
/**
* Broadcast action: send when any policy admin changes a policy.
* This is generally used to find out when a new policy is in effect.
*
* @hide
*/
@UnsupportedAppUsage
public static final String ACTION_DEVICE_POLICY_MANAGER_STATE_CHANGED
= "android.app.action.DEVICE_POLICY_MANAGER_STATE_CHANGED";
/**
* Broadcast action: sent when the device owner is set, changed or cleared.
*
* This broadcast is sent only to the primary user.
* @see #ACTION_PROVISION_MANAGED_DEVICE
* @see DevicePolicyManager#transferOwnership(ComponentName, ComponentName, PersistableBundle)
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_DEVICE_OWNER_CHANGED
= "android.app.action.DEVICE_OWNER_CHANGED";
/**
* The ComponentName of the administrator component.
*
* @see #ACTION_ADD_DEVICE_ADMIN
*/
public static final String EXTRA_DEVICE_ADMIN = "android.app.extra.DEVICE_ADMIN";
/**
* An optional CharSequence providing additional explanation for why the
* admin is being added.
*
* @see #ACTION_ADD_DEVICE_ADMIN
*/
public static final String EXTRA_ADD_EXPLANATION = "android.app.extra.ADD_EXPLANATION";
/**
* Constant to indicate the feature of disabling the camera. Used as argument to
* {@link #createAdminSupportIntent(String)}.
* @see #setCameraDisabled(ComponentName, boolean)
*/
public static final String POLICY_DISABLE_CAMERA = "policy_disable_camera";
/**
* Constant to indicate the feature of disabling screen captures. Used as argument to
* {@link #createAdminSupportIntent(String)}.
* @see #setScreenCaptureDisabled(ComponentName, boolean)
*/
public static final String POLICY_DISABLE_SCREEN_CAPTURE = "policy_disable_screen_capture";
/**
* Constant to indicate the feature of suspending app. Use it as the value of
* {@link #EXTRA_RESTRICTION}.
* @hide
*/
public static final String POLICY_SUSPEND_PACKAGES = "policy_suspend_packages";
/**
* A String indicating a specific restricted feature. Can be a user restriction from the
* {@link UserManager}, e.g. {@link UserManager#DISALLOW_ADJUST_VOLUME}, or one of the values
* {@link #POLICY_DISABLE_CAMERA} or {@link #POLICY_DISABLE_SCREEN_CAPTURE}.
* @see #createAdminSupportIntent(String)
* @hide
*/
@TestApi @SystemApi
public static final String EXTRA_RESTRICTION = "android.app.extra.RESTRICTION";
/**
* Activity action: have the user enter a new password.
*
* <p>For admin apps, this activity should be launched after using {@link
* #setPasswordQuality(ComponentName, int)}, or {@link
* #setPasswordMinimumLength(ComponentName, int)} to have the user enter a new password that
* meets the current requirements. You can use {@link #isActivePasswordSufficient()} to
* determine whether you need to have the user select a new password in order to meet the
* current constraints. Upon being resumed from this activity, you can check the new
* password characteristics to see if they are sufficient.
*
* <p>Non-admin apps can use {@link #getPasswordComplexity()} to check the current screen lock
* complexity, and use this activity with extra {@link #EXTRA_PASSWORD_COMPLEXITY} to suggest
* to users how complex the app wants the new screen lock to be. Note that both {@link
* #getPasswordComplexity()} and the extra {@link #EXTRA_PASSWORD_COMPLEXITY} require the
* calling app to have the permission {@link permission#REQUEST_PASSWORD_COMPLEXITY}.
*
* <p>If the intent is launched from within a managed profile with a profile
* owner built against {@link android.os.Build.VERSION_CODES#M} or before,
* this will trigger entering a new password for the parent of the profile.
* For all other cases it will trigger entering a new password for the user
* or profile it is launched from.
*
* @see #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_SET_NEW_PASSWORD
= "android.app.action.SET_NEW_PASSWORD";
/**
* An integer indicating the complexity level of the new password an app would like the user to
* set when launching the action {@link #ACTION_SET_NEW_PASSWORD}.
*
* <p>Must be one of
* <ul>
* <li>{@link #PASSWORD_COMPLEXITY_HIGH}
* <li>{@link #PASSWORD_COMPLEXITY_MEDIUM}
* <li>{@link #PASSWORD_COMPLEXITY_LOW}
* <li>{@link #PASSWORD_COMPLEXITY_NONE}
* </ul>
*
* <p>If an invalid value is used, it will be treated as {@link #PASSWORD_COMPLEXITY_NONE}.
*/
@RequiresPermission(android.Manifest.permission.REQUEST_PASSWORD_COMPLEXITY)
public static final String EXTRA_PASSWORD_COMPLEXITY =
"android.app.extra.PASSWORD_COMPLEXITY";
/**
* Constant for {@link #getPasswordComplexity()}: no password.
*
* <p>Note that these complexity constants are ordered so that higher values are more complex.
*/
public static final int PASSWORD_COMPLEXITY_NONE = 0;
/**
* Constant for {@link #getPasswordComplexity()}: password satisfies one of the following:
* <ul>
* <li>pattern
* <li>PIN with repeating (4444) or ordered (1234, 4321, 2468) sequences
* </ul>
*
* <p>Note that these complexity constants are ordered so that higher values are more complex.
*
* @see #PASSWORD_QUALITY_SOMETHING
* @see #PASSWORD_QUALITY_NUMERIC
*/
public static final int PASSWORD_COMPLEXITY_LOW = 0x10000;
/**
* Constant for {@link #getPasswordComplexity()}: password satisfies one of the following:
* <ul>
* <li>PIN with <b>no</b> repeating (4444) or ordered (1234, 4321, 2468) sequences, length at
* least 4
* <li>alphabetic, length at least 4
* <li>alphanumeric, length at least 4
* </ul>
*
* <p>Note that these complexity constants are ordered so that higher values are more complex.
*
* @see #PASSWORD_QUALITY_NUMERIC_COMPLEX
* @see #PASSWORD_QUALITY_ALPHABETIC
* @see #PASSWORD_QUALITY_ALPHANUMERIC
*/
public static final int PASSWORD_COMPLEXITY_MEDIUM = 0x30000;
/**
* Constant for {@link #getPasswordComplexity()}: password satisfies one of the following:
* <ul>
* <li>PIN with <b>no</b> repeating (4444) or ordered (1234, 4321, 2468) sequences, length at
* least 8
* <li>alphabetic, length at least 6
* <li>alphanumeric, length at least 6
* </ul>
*
* <p>Note that these complexity constants are ordered so that higher values are more complex.
*
* @see #PASSWORD_QUALITY_NUMERIC_COMPLEX
* @see #PASSWORD_QUALITY_ALPHABETIC
* @see #PASSWORD_QUALITY_ALPHANUMERIC
*/
public static final int PASSWORD_COMPLEXITY_HIGH = 0x50000;
/**
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = {"PASSWORD_COMPLEXITY_"}, value = {
PASSWORD_COMPLEXITY_NONE,
PASSWORD_COMPLEXITY_LOW,
PASSWORD_COMPLEXITY_MEDIUM,
PASSWORD_COMPLEXITY_HIGH,
})
public @interface PasswordComplexity {}
/**
* Activity action: have the user enter a new password for the parent profile.
* If the intent is launched from within a managed profile, this will trigger
* entering a new password for the parent of the profile. In all other cases
* the behaviour is identical to {@link #ACTION_SET_NEW_PASSWORD}.
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_SET_NEW_PARENT_PROFILE_PASSWORD
= "android.app.action.SET_NEW_PARENT_PROFILE_PASSWORD";
/**
* Broadcast action: Tell the status bar to open the device monitoring dialog, e.g. when
* Network logging was enabled and the user tapped the notification.
* <p class="note">This is a protected intent that can only be sent by the system.</p>
* @hide
*/
public static final String ACTION_SHOW_DEVICE_MONITORING_DIALOG
= "android.app.action.SHOW_DEVICE_MONITORING_DIALOG";
/**
* Broadcast Action: Sent after application delegation scopes are changed. The new delegation
* scopes will be sent in an {@code ArrayList<String>} extra identified by the
* {@link #EXTRA_DELEGATION_SCOPES} key.
*
* <p class="note"><b>Note:</b> This is a protected intent that can only be sent by the
* system.</p>
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED =
"android.app.action.APPLICATION_DELEGATION_SCOPES_CHANGED";
/**
* An {@code ArrayList<String>} corresponding to the delegation scopes given to an app in the
* {@link #ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED} broadcast.
*/
public static final String EXTRA_DELEGATION_SCOPES = "android.app.extra.DELEGATION_SCOPES";
/**
* Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
* the parent profile to access intents sent from the managed profile.
* That is, when an app in the managed profile calls
* {@link Activity#startActivity(Intent)}, the intent can be resolved by a
* matching activity in the parent profile.
*/
public static final int FLAG_PARENT_CAN_ACCESS_MANAGED = 0x0001;
/**
* Flag used by {@link #addCrossProfileIntentFilter} to allow activities in
* the managed profile to access intents sent from the parent profile.
* That is, when an app in the parent profile calls
* {@link Activity#startActivity(Intent)}, the intent can be resolved by a
* matching activity in the managed profile.
*/
public static final int FLAG_MANAGED_CAN_ACCESS_PARENT = 0x0002;
/**
* Broadcast action: notify that a new local system update policy has been set by the device
* owner. The new policy can be retrieved by {@link #getSystemUpdatePolicy()}.
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_SYSTEM_UPDATE_POLICY_CHANGED
= "android.app.action.SYSTEM_UPDATE_POLICY_CHANGED";
/**
* Broadcast action to notify ManagedProvisioning that
* {@link UserManager#DISALLOW_SHARE_INTO_MANAGED_PROFILE} restriction has changed.
* @hide
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_DATA_SHARING_RESTRICTION_CHANGED =
"android.app.action.DATA_SHARING_RESTRICTION_CHANGED";
/**
* Broadcast action from ManagedProvisioning to notify that the latest change to
* {@link UserManager#DISALLOW_SHARE_INTO_MANAGED_PROFILE} restriction has been successfully
* applied (cross profile intent filters updated). Only usesd for CTS tests.
* @hide
*/
@TestApi
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_DATA_SHARING_RESTRICTION_APPLIED =
"android.app.action.DATA_SHARING_RESTRICTION_APPLIED";
/**
* Permission policy to prompt user for new permission requests for runtime permissions.
* Already granted or denied permissions are not affected by this.
*/
public static final int PERMISSION_POLICY_PROMPT = 0;
/**
* Permission policy to always grant new permission requests for runtime permissions.
* Already granted or denied permissions are not affected by this.
*/
public static final int PERMISSION_POLICY_AUTO_GRANT = 1;
/**
* Permission policy to always deny new permission requests for runtime permissions.
* Already granted or denied permissions are not affected by this.
*/
public static final int PERMISSION_POLICY_AUTO_DENY = 2;
/**
* Possible policy values for permissions.
*
* @hide
*/
@IntDef(prefix = { "PERMISSION_GRANT_STATE_" }, value = {
PERMISSION_GRANT_STATE_DEFAULT,
PERMISSION_GRANT_STATE_GRANTED,
PERMISSION_GRANT_STATE_DENIED
})
@Retention(RetentionPolicy.SOURCE)
public @interface PermissionGrantState {}
/**
* Runtime permission state: The user can manage the permission
* through the UI.
*/
public static final int PERMISSION_GRANT_STATE_DEFAULT = 0;
/**
* Runtime permission state: The permission is granted to the app
* and the user cannot manage the permission through the UI.
*/
public static final int PERMISSION_GRANT_STATE_GRANTED = 1;
/**
* Runtime permission state: The permission is denied to the app
* and the user cannot manage the permission through the UI.
*/
public static final int PERMISSION_GRANT_STATE_DENIED = 2;
/**
* Delegation of certificate installation and management. This scope grants access to the
* {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
* {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair} APIs.
*/
public static final String DELEGATION_CERT_INSTALL = "delegation-cert-install";
/**
* Delegation of application restrictions management. This scope grants access to the
* {@link #setApplicationRestrictions} and {@link #getApplicationRestrictions} APIs.
*/
public static final String DELEGATION_APP_RESTRICTIONS = "delegation-app-restrictions";
/**
* Delegation of application uninstall block. This scope grants access to the
* {@link #setUninstallBlocked} API.
*/
public static final String DELEGATION_BLOCK_UNINSTALL = "delegation-block-uninstall";
/**
* Delegation of permission policy and permission grant state. This scope grants access to the
* {@link #setPermissionPolicy}, {@link #getPermissionGrantState},
* and {@link #setPermissionGrantState} APIs.
*/
public static final String DELEGATION_PERMISSION_GRANT = "delegation-permission-grant";
/**
* Delegation of package access state. This scope grants access to the
* {@link #isApplicationHidden}, {@link #setApplicationHidden}, {@link #isPackageSuspended}, and
* {@link #setPackagesSuspended} APIs.
*/
public static final String DELEGATION_PACKAGE_ACCESS = "delegation-package-access";
/**
* Delegation for enabling system apps. This scope grants access to the {@link #enableSystemApp}
* API.
*/
public static final String DELEGATION_ENABLE_SYSTEM_APP = "delegation-enable-system-app";
/**
* Delegation for installing existing packages. This scope grants access to the
* {@link #installExistingPackage} API.
*/
public static final String DELEGATION_INSTALL_EXISTING_PACKAGE =
"delegation-install-existing-package";
/**
* Delegation of management of uninstalled packages. This scope grants access to the
* {@link #setKeepUninstalledPackages} and {@link #getKeepUninstalledPackages} APIs.
*/
public static final String DELEGATION_KEEP_UNINSTALLED_PACKAGES =
"delegation-keep-uninstalled-packages";
/**
* Grants access to {@link #setNetworkLoggingEnabled}, {@link #isNetworkLoggingEnabled} and
* {@link #retrieveNetworkLogs}. Once granted the delegated app will start receiving
* DelegatedAdminReceiver.onNetworkLogsAvailable() callback, and Device owner will no longer
* receive the DeviceAdminReceiver.onNetworkLogsAvailable() callback.
* There can be at most one app that has this delegation.
* If another app already had delegated network logging access,
* it will lose the delegation when a new app is delegated.
*
* <p> Can only be granted by Device Owner.
*/
public static final String DELEGATION_NETWORK_LOGGING = "delegation-network-logging";
/**
* Grants access to selection of KeyChain certificates on behalf of requesting apps.
* Once granted the app will start receiving
* DelegatedAdminReceiver.onChoosePrivateKeyAlias. The caller (PO/DO) will
* no longer receive {@link DeviceAdminReceiver#onChoosePrivateKeyAlias}.
* There can be at most one app that has this delegation.
* If another app already had delegated certificate selection access,
* it will lose the delegation when a new app is delegated.
*
* <p> Can be granted by Device Owner or Profile Owner.
*/
public static final String DELEGATION_CERT_SELECTION = "delegation-cert-selection";
/**
* No management for current user in-effect. This is the default.
* @hide
*/
@SystemApi
public static final int STATE_USER_UNMANAGED = 0;
/**
* Management partially setup, user setup needs to be completed.
* @hide
*/
@SystemApi
public static final int STATE_USER_SETUP_INCOMPLETE = 1;
/**
* Management partially setup, user setup completed.
* @hide
*/
@SystemApi
public static final int STATE_USER_SETUP_COMPLETE = 2;
/**
* Management setup and active on current user.
* @hide
*/
@SystemApi
public static final int STATE_USER_SETUP_FINALIZED = 3;
/**
* Management partially setup on a managed profile.
* @hide
*/
@SystemApi
public static final int STATE_USER_PROFILE_COMPLETE = 4;
/**
* @hide
*/
@IntDef(prefix = { "STATE_USER_" }, value = {
STATE_USER_UNMANAGED,
STATE_USER_SETUP_INCOMPLETE,
STATE_USER_SETUP_COMPLETE,
STATE_USER_SETUP_FINALIZED,
STATE_USER_PROFILE_COMPLETE
})
@Retention(RetentionPolicy.SOURCE)
public @interface UserProvisioningState {}
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
* {@link #ACTION_PROVISION_MANAGED_PROFILE}, {@link #ACTION_PROVISION_MANAGED_USER} and
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when provisioning is allowed.
*
* @hide
*/
public static final int CODE_OK = 0;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the device already has a device
* owner.
*
* @hide
*/
public static final int CODE_HAS_DEVICE_OWNER = 1;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the user has a profile owner and for
* {@link #ACTION_PROVISION_MANAGED_PROFILE} when the profile owner is already set.
*
* @hide
*/
public static final int CODE_USER_HAS_PROFILE_OWNER = 2;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} when the user isn't running.
*
* @hide
*/
public static final int CODE_USER_NOT_RUNNING = 3;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} if the device has already been setup and
* for {@link #ACTION_PROVISION_MANAGED_USER} if the user has already been setup.
*
* @hide
*/
public static final int CODE_USER_SETUP_COMPLETED = 4;
/**
* Code used to indicate that the device also has a user other than the system user.
*
* @hide
*/
public static final int CODE_NONSYSTEM_USER_EXISTS = 5;
/**
* Code used to indicate that device has an account that prevents provisioning.
*
* @hide
*/
public static final int CODE_ACCOUNTS_NOT_EMPTY = 6;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE} and
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} if the user is not a system user.
*
* @hide
*/
public static final int CODE_NOT_SYSTEM_USER = 7;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} and {@link #ACTION_PROVISION_MANAGED_USER}
* when the device is a watch and is already paired.
*
* @hide
*/
public static final int CODE_HAS_PAIRED = 8;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} and
* {@link #ACTION_PROVISION_MANAGED_USER} on devices which do not support managed users.
*
* @see {@link PackageManager#FEATURE_MANAGED_USERS}
* @hide
*/
public static final int CODE_MANAGED_USERS_NOT_SUPPORTED = 9;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_USER} if the user is a system user.
*
* @hide
*/
public static final int CODE_SYSTEM_USER = 10;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when the user cannot have more
* managed profiles.
*
* @hide
*/
public static final int CODE_CANNOT_ADD_MANAGED_PROFILE = 11;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_USER} and
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} on devices not running with split system
* user.
*
* @hide
*/
public static final int CODE_NOT_SYSTEM_USER_SPLIT = 12;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_DEVICE},
* {@link #ACTION_PROVISION_MANAGED_PROFILE}, {@link #ACTION_PROVISION_MANAGED_USER} and
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE} on devices which do no support device
* admins.
*
* @hide
*/
public static final int CODE_DEVICE_ADMIN_NOT_SUPPORTED = 13;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when the device the user is a
* system user on a split system user device.
*
* @hide
*/
public static final int CODE_SPLIT_SYSTEM_USER_DEVICE_SYSTEM_USER = 14;
/**
* Result code for {@link #checkProvisioningPreCondition}.
*
* <p>Returned for {@link #ACTION_PROVISION_MANAGED_PROFILE} when adding a managed profile is
* disallowed by {@link UserManager#DISALLOW_ADD_MANAGED_PROFILE}.
*
* @hide
*/
public static final int CODE_ADD_MANAGED_PROFILE_DISALLOWED = 15;
/**
* Result codes for {@link #checkProvisioningPreCondition} indicating all the provisioning pre
* conditions.
*
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(prefix = { "CODE_" }, value = {
CODE_OK, CODE_HAS_DEVICE_OWNER, CODE_USER_HAS_PROFILE_OWNER, CODE_USER_NOT_RUNNING,
CODE_USER_SETUP_COMPLETED, CODE_NOT_SYSTEM_USER, CODE_HAS_PAIRED,
CODE_MANAGED_USERS_NOT_SUPPORTED, CODE_SYSTEM_USER, CODE_CANNOT_ADD_MANAGED_PROFILE,
CODE_NOT_SYSTEM_USER_SPLIT, CODE_DEVICE_ADMIN_NOT_SUPPORTED,
CODE_SPLIT_SYSTEM_USER_DEVICE_SYSTEM_USER, CODE_ADD_MANAGED_PROFILE_DISALLOWED
})
public @interface ProvisioningPreCondition {}
/**
* Disable all configurable SystemUI features during LockTask mode. This includes,
* <ul>
* <li>system info area in the status bar (connectivity icons, clock, etc.)
* <li>notifications (including alerts, icons, and the notification shade)
* <li>Home button
* <li>Recents button and UI
* <li>global actions menu (i.e. power button menu)
* <li>keyguard
* </ul>
*
* @see #setLockTaskFeatures(ComponentName, int)
*/
public static final int LOCK_TASK_FEATURE_NONE = 0;
/**
* Enable the system info area in the status bar during LockTask mode. The system info area
* usually occupies the right side of the status bar (although this can differ across OEMs). It
* includes all system information indicators, such as date and time, connectivity, battery,
* vibration mode, etc.
*
* @see #setLockTaskFeatures(ComponentName, int)
*/
public static final int LOCK_TASK_FEATURE_SYSTEM_INFO = 1;
/**
* Enable notifications during LockTask mode. This includes notification icons on the status
* bar, heads-up notifications, and the expandable notification shade. Note that the Quick
* Settings panel remains disabled. This feature flag can only be used in combination with
* {@link #LOCK_TASK_FEATURE_HOME}. {@link #setLockTaskFeatures(ComponentName, int)}
* throws an {@link IllegalArgumentException} if this feature flag is defined without
* {@link #LOCK_TASK_FEATURE_HOME}.
*
* @see #setLockTaskFeatures(ComponentName, int)
*/
public static final int LOCK_TASK_FEATURE_NOTIFICATIONS = 1 << 1;
/**
* Enable the Home button during LockTask mode. Note that if a custom launcher is used, it has
* to be registered as the default launcher with
* {@link #addPersistentPreferredActivity(ComponentName, IntentFilter, ComponentName)}, and its
* package needs to be whitelisted for LockTask with
* {@link #setLockTaskPackages(ComponentName, String[])}.
*
* @see #setLockTaskFeatures(ComponentName, int)
*/
public static final int LOCK_TASK_FEATURE_HOME = 1 << 2;
/**
* Enable the Overview button and the Overview screen during LockTask mode. This feature flag
* can only be used in combination with {@link #LOCK_TASK_FEATURE_HOME}, and
* {@link #setLockTaskFeatures(ComponentName, int)} will throw an
* {@link IllegalArgumentException} if this feature flag is defined without
* {@link #LOCK_TASK_FEATURE_HOME}.
*
* @see #setLockTaskFeatures(ComponentName, int)
*/
public static final int LOCK_TASK_FEATURE_OVERVIEW = 1 << 3;
/**
* Enable the global actions dialog during LockTask mode. This is the dialog that shows up when
* the user long-presses the power button, for example. Note that the user may not be able to
* power off the device if this flag is not set.
*
* <p>This flag is enabled by default until {@link #setLockTaskFeatures(ComponentName, int)} is
* called for the first time.
*
* @see #setLockTaskFeatures(ComponentName, int)
*/
public static final int LOCK_TASK_FEATURE_GLOBAL_ACTIONS = 1 << 4;
/**
* Enable the keyguard during LockTask mode. Note that if the keyguard is already disabled with
* {@link #setKeyguardDisabled(ComponentName, boolean)}, setting this flag will have no effect.
* If this flag is not set, the keyguard will not be shown even if the user has a lock screen
* credential.
*
* @see #setLockTaskFeatures(ComponentName, int)
*/
public static final int LOCK_TASK_FEATURE_KEYGUARD = 1 << 5;
/**
* Flags supplied to {@link #setLockTaskFeatures(ComponentName, int)}.
*
* @hide
*/
@Retention(RetentionPolicy.SOURCE)
@IntDef(flag = true, prefix = { "LOCK_TASK_FEATURE_" }, value = {
LOCK_TASK_FEATURE_NONE,
LOCK_TASK_FEATURE_SYSTEM_INFO,
LOCK_TASK_FEATURE_NOTIFICATIONS,
LOCK_TASK_FEATURE_HOME,
LOCK_TASK_FEATURE_OVERVIEW,
LOCK_TASK_FEATURE_GLOBAL_ACTIONS,
LOCK_TASK_FEATURE_KEYGUARD
})
public @interface LockTaskFeature {}
/**
* Service action: Action for a service that device owner and profile owner can optionally
* own. If a device owner or a profile owner has such a service, the system tries to keep
* a bound connection to it, in order to keep their process always running.
* The service must be protected with the {@link android.Manifest.permission#BIND_DEVICE_ADMIN}
* permission.
*/
@SdkConstant(SdkConstantType.SERVICE_ACTION)
public static final String ACTION_DEVICE_ADMIN_SERVICE
= "android.app.action.DEVICE_ADMIN_SERVICE";
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(flag = true, prefix = {"ID_TYPE_"}, value = {
ID_TYPE_BASE_INFO,
ID_TYPE_SERIAL,
ID_TYPE_IMEI,
ID_TYPE_MEID
})
public @interface AttestationIdType {}
/**
* Specifies that the device should attest its manufacturer details. For use with
* {@link #generateKeyPair}.
*
* @see #generateKeyPair
*/
public static final int ID_TYPE_BASE_INFO = 1;
/**
* Specifies that the device should attest its serial number. For use with
* {@link #generateKeyPair}.
*
* @see #generateKeyPair
*/
public static final int ID_TYPE_SERIAL = 2;
/**
* Specifies that the device should attest its IMEI. For use with {@link #generateKeyPair}.
*
* @see #generateKeyPair
*/
public static final int ID_TYPE_IMEI = 4;
/**
* Specifies that the device should attest its MEID. For use with {@link #generateKeyPair}.
*
* @see #generateKeyPair
*/
public static final int ID_TYPE_MEID = 8;
/**
* Service-specific error code for {@link #generateKeyPair}:
* Indicates the call has failed due to StrongBox unavailability.
* @hide
*/
public static final int KEY_GEN_STRONGBOX_UNAVAILABLE = 1;
/**
* Specifies that the calling app should be granted access to the installed credentials
* immediately. Otherwise, access to the credentials will be gated by user approval.
* For use with {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, int)}
*
* @see #installKeyPair(ComponentName, PrivateKey, Certificate[], String, int)
*/
public static final int INSTALLKEY_REQUEST_CREDENTIALS_ACCESS = 1;
/**
* Specifies that a user can select the key via the Certificate Selection prompt.
* If this flag is not set when calling {@link #installKeyPair}, the key can only be granted
* access by implementing {@link android.app.admin.DeviceAdminReceiver#onChoosePrivateKeyAlias}.
* For use with {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, int)}
*
* @see #installKeyPair(ComponentName, PrivateKey, Certificate[], String, int)
*/
public static final int INSTALLKEY_SET_USER_SELECTABLE = 2;
/**
* Broadcast action: sent when the profile owner is set, changed or cleared.
*
* This broadcast is sent only to the user managed by the new profile owner.
* @see DevicePolicyManager#transferOwnership(ComponentName, ComponentName, PersistableBundle)
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_PROFILE_OWNER_CHANGED =
"android.app.action.PROFILE_OWNER_CHANGED";
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(flag = true, prefix = {"PRIVATE_DNS_MODE_"}, value = {
PRIVATE_DNS_MODE_UNKNOWN,
PRIVATE_DNS_MODE_OFF,
PRIVATE_DNS_MODE_OPPORTUNISTIC,
PRIVATE_DNS_MODE_PROVIDER_HOSTNAME
})
public @interface PrivateDnsMode {}
/**
* Specifies that the Private DNS setting is in an unknown state.
*/
public static final int PRIVATE_DNS_MODE_UNKNOWN = 0;
/**
* Specifies that Private DNS was turned off completely.
*/
public static final int PRIVATE_DNS_MODE_OFF = 1;
/**
* Specifies that the device owner requested opportunistic DNS over TLS
*/
public static final int PRIVATE_DNS_MODE_OPPORTUNISTIC = 2;
/**
* Specifies that the device owner configured a specific host to use for Private DNS.
*/
public static final int PRIVATE_DNS_MODE_PROVIDER_HOSTNAME = 3;
/**
* Callback used in {@link #installSystemUpdate} to indicate that there was an error while
* trying to install an update.
*/
public abstract static class InstallSystemUpdateCallback {
/** Represents an unknown error while trying to install an update. */
public static final int UPDATE_ERROR_UNKNOWN = 1;
/** Represents the update file being intended for different OS version. */
public static final int UPDATE_ERROR_INCORRECT_OS_VERSION = 2;
/**
* Represents the update file being wrong; e.g. payloads are mismatched, or the wrong
* compression method is used.
*/
public static final int UPDATE_ERROR_UPDATE_FILE_INVALID = 3;
/** Represents that the file could not be found. */
public static final int UPDATE_ERROR_FILE_NOT_FOUND = 4;
/** Represents the battery being too low to apply an update. */
public static final int UPDATE_ERROR_BATTERY_LOW = 5;
/**
* Method invoked when there was an error while installing an update.
*
* <p>The given error message is not intended to be user-facing. It is intended to be
* reported back to the IT admin to be read.
*/
public void onInstallUpdateError(
@InstallUpdateCallbackErrorConstants int errorCode, @NonNull String errorMessage) {
}
}
/**
* @hide
*/
@IntDef(prefix = { "UPDATE_ERROR_" }, value = {
InstallSystemUpdateCallback.UPDATE_ERROR_UNKNOWN,
InstallSystemUpdateCallback.UPDATE_ERROR_INCORRECT_OS_VERSION,
InstallSystemUpdateCallback.UPDATE_ERROR_UPDATE_FILE_INVALID,
InstallSystemUpdateCallback.UPDATE_ERROR_FILE_NOT_FOUND,
InstallSystemUpdateCallback.UPDATE_ERROR_BATTERY_LOW
})
@Retention(RetentionPolicy.SOURCE)
public @interface InstallUpdateCallbackErrorConstants {}
/**
* The selected mode has been set successfully. If the mode is
* {@code PRIVATE_DNS_MODE_PROVIDER_HOSTNAME} then it implies the supplied host is valid
* and reachable.
*/
public static final int PRIVATE_DNS_SET_NO_ERROR = 0;
/**
* If the {@code privateDnsHost} provided was of a valid hostname but that host was found
* to not support DNS-over-TLS.
*/
public static final int PRIVATE_DNS_SET_ERROR_HOST_NOT_SERVING = 1;
/**
* General failure to set the Private DNS mode, not due to one of the reasons listed above.
*/
public static final int PRIVATE_DNS_SET_ERROR_FAILURE_SETTING = 2;
/**
* @hide
*/
@IntDef(prefix = {"PRIVATE_DNS_SET_"}, value = {
PRIVATE_DNS_SET_NO_ERROR,
PRIVATE_DNS_SET_ERROR_HOST_NOT_SERVING,
PRIVATE_DNS_SET_ERROR_FAILURE_SETTING
})
@Retention(RetentionPolicy.SOURCE)
public @interface PrivateDnsModeErrorCodes {}
/**
* Activity action: Starts the administrator to get the mode for the provisioning.
* This intent may contain the following extras:
* <ul>
* <li>{@link #EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE}</li>
* <li>{@link #EXTRA_PROVISIONING_IMEI}</li>
* <li>{@link #EXTRA_PROVISIONING_SERIAL_NUMBER}</li>
* </ul>
*
* <p>The target activity should return one of the following values in
* {@link #EXTRA_PROVISIONING_MODE} as result:
* <ul>
* <li>{@link #PROVISIONING_MODE_FULLY_MANAGED_DEVICE}</li>
* <li>{@link #PROVISIONING_MODE_MANAGED_PROFILE}</li>
* </ul>
*
* <p>If performing fully-managed device provisioning and the admin app desires to show its
* own education screens, the target activity can additionally return
* {@link #EXTRA_PROVISIONING_SKIP_EDUCATION_SCREENS} set to <code>true</code>.
*
* <p>The target activity may also return the account that needs to be migrated from primary
* user to managed profile in case of a profile owner provisioning in
* {@link #EXTRA_PROVISIONING_ACCOUNT_TO_MIGRATE} as result.
*/
public static final String ACTION_GET_PROVISIONING_MODE =
"android.app.action.GET_PROVISIONING_MODE";
/**
* A string extra holding the IMEI (International Mobile Equipment Identity) of the device.
*/
public static final String EXTRA_PROVISIONING_IMEI = "android.app.extra.PROVISIONING_IMEI";
/**
* A string extra holding the serial number of the device.
*/
public static final String EXTRA_PROVISIONING_SERIAL_NUMBER =
"android.app.extra.PROVISIONING_SERIAL_NUMBER";
/**
* An intent extra holding the provisioning mode returned by the administrator.
* The value for this extra should be one of the following:
* <ul>
* <li>{@link #PROVISIONING_MODE_FULLY_MANAGED_DEVICE}</li>
* <li>{@link #PROVISIONING_MODE_MANAGED_PROFILE}</li>
* </ul>
*/
public static final String EXTRA_PROVISIONING_MODE =
"android.app.extra.PROVISIONING_MODE";
/**
* The provisioning mode for fully managed device.
*/
public static final int PROVISIONING_MODE_FULLY_MANAGED_DEVICE = 1;
/**
* The provisioning mode for managed profile.
*/
public static final int PROVISIONING_MODE_MANAGED_PROFILE = 2;
/**
* Activity action: Starts the administrator to show policy compliance for the provisioning.
*/
public static final String ACTION_ADMIN_POLICY_COMPLIANCE =
"android.app.action.ADMIN_POLICY_COMPLIANCE";
/**
* Return true if the given administrator component is currently active (enabled) in the system.
*
* @param admin The administrator component to check for.
* @return {@code true} if {@code admin} is currently enabled in the system, {@code false}
* otherwise
*/
public boolean isAdminActive(@NonNull ComponentName admin) {
throwIfParentInstance("isAdminActive");
return isAdminActiveAsUser(admin, myUserId());
}
/**
* @see #isAdminActive(ComponentName)
* @hide
*/
public boolean isAdminActiveAsUser(@NonNull ComponentName admin, int userId) {
if (mService != null) {
try {
return mService.isAdminActive(admin, userId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Return true if the given administrator component is currently being removed
* for the user.
* @hide
*/
public boolean isRemovingAdmin(@NonNull ComponentName admin, int userId) {
if (mService != null) {
try {
return mService.isRemovingAdmin(admin, userId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Return a list of all currently active device administrators' component
* names. If there are no administrators {@code null} may be
* returned.
*/
public @Nullable List<ComponentName> getActiveAdmins() {
throwIfParentInstance("getActiveAdmins");
return getActiveAdminsAsUser(myUserId());
}
/**
* @see #getActiveAdmins()
* @hide
*/
@UnsupportedAppUsage
public @Nullable List<ComponentName> getActiveAdminsAsUser(int userId) {
if (mService != null) {
try {
return mService.getActiveAdmins(userId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Used by package administration code to determine if a package can be stopped
* or uninstalled.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL)
public boolean packageHasActiveAdmins(String packageName) {
return packageHasActiveAdmins(packageName, myUserId());
}
/**
* Used by package administration code to determine if a package can be stopped
* or uninstalled.
* @hide
*/
@UnsupportedAppUsage
public boolean packageHasActiveAdmins(String packageName, int userId) {
if (mService != null) {
try {
return mService.packageHasActiveAdmins(packageName, userId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Remove a current administration component. This can only be called
* by the application that owns the administration component; if you
* try to remove someone else's component, a security exception will be
* thrown.
*
* <p>Note that the operation is not synchronous and the admin might still be active (as
* indicated by {@link #getActiveAdmins()}) by the time this method returns.
*
* @param admin The administration compononent to remove.
* @throws SecurityException if the caller is not in the owner application of {@code admin}.
*/
public void removeActiveAdmin(@NonNull ComponentName admin) {
throwIfParentInstance("removeActiveAdmin");
if (mService != null) {
try {
mService.removeActiveAdmin(admin, myUserId());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Returns true if an administrator has been granted a particular device policy. This can be
* used to check whether the administrator was activated under an earlier set of policies, but
* requires additional policies after an upgrade.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with. Must be an
* active administrator, or an exception will be thrown.
* @param usesPolicy Which uses-policy to check, as defined in {@link DeviceAdminInfo}.
* @throws SecurityException if {@code admin} is not an active administrator.
*/
public boolean hasGrantedPolicy(@NonNull ComponentName admin, int usesPolicy) {
throwIfParentInstance("hasGrantedPolicy");
if (mService != null) {
try {
return mService.hasGrantedPolicy(admin, usesPolicy, myUserId());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Returns true if the Profile Challenge is available to use for the given profile user.
*
* @hide
*/
public boolean isSeparateProfileChallengeAllowed(int userHandle) {
if (mService != null) {
try {
return mService.isSeparateProfileChallengeAllowed(userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Constant for {@link #setPasswordQuality}: the policy has no requirements
* for the password. Note that quality constants are ordered so that higher
* values are more restrictive.
*/
public static final int PASSWORD_QUALITY_UNSPECIFIED = 0;
/**
* Constant for {@link #setPasswordQuality}: the policy allows for low-security biometric
* recognition technology. This implies technologies that can recognize the identity of
* an individual to about a 3 digit PIN (false detection is less than 1 in 1,000).
* Note that quality constants are ordered so that higher values are more restrictive.
*/
public static final int PASSWORD_QUALITY_BIOMETRIC_WEAK = 0x8000;
/**
* Constant for {@link #setPasswordQuality}: the policy requires some kind
* of password or pattern, but doesn't care what it is. Note that quality constants
* are ordered so that higher values are more restrictive.
*/
public static final int PASSWORD_QUALITY_SOMETHING = 0x10000;
/**
* Constant for {@link #setPasswordQuality}: the user must have entered a
* password containing at least numeric characters. Note that quality
* constants are ordered so that higher values are more restrictive.
*/
public static final int PASSWORD_QUALITY_NUMERIC = 0x20000;
/**
* Constant for {@link #setPasswordQuality}: the user must have entered a
* password containing at least numeric characters with no repeating (4444)
* or ordered (1234, 4321, 2468) sequences. Note that quality
* constants are ordered so that higher values are more restrictive.
*/
public static final int PASSWORD_QUALITY_NUMERIC_COMPLEX = 0x30000;
/**
* Constant for {@link #setPasswordQuality}: the user must have entered a
* password containing at least alphabetic (or other symbol) characters.
* Note that quality constants are ordered so that higher values are more
* restrictive.
*/
public static final int PASSWORD_QUALITY_ALPHABETIC = 0x40000;
/**
* Constant for {@link #setPasswordQuality}: the user must have entered a
* password containing at least <em>both></em> numeric <em>and</em>
* alphabetic (or other symbol) characters. Note that quality constants are
* ordered so that higher values are more restrictive.
*/
public static final int PASSWORD_QUALITY_ALPHANUMERIC = 0x50000;
/**
* Constant for {@link #setPasswordQuality}: the user must have entered a
* password containing at least a letter, a numerical digit and a special
* symbol, by default. With this password quality, passwords can be
* restricted to contain various sets of characters, like at least an
* uppercase letter, etc. These are specified using various methods,
* like {@link #setPasswordMinimumLowerCase(ComponentName, int)}. Note
* that quality constants are ordered so that higher values are more
* restrictive.
*/
public static final int PASSWORD_QUALITY_COMPLEX = 0x60000;
/**
* Constant for {@link #setPasswordQuality}: the user is not allowed to
* modify password. In case this password quality is set, the password is
* managed by a profile owner. The profile owner can set any password,
* as if {@link #PASSWORD_QUALITY_UNSPECIFIED} is used. Note
* that quality constants are ordered so that higher values are more
* restrictive. The value of {@link #PASSWORD_QUALITY_MANAGED} is
* the highest.
* @hide
*/
public static final int PASSWORD_QUALITY_MANAGED = 0x80000;
/**
* @hide
*
* adb shell dpm set-{device,profile}-owner will normally not allow installing an owner to
* a user with accounts. {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED}
* and {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} are the account features
* used by authenticator to exempt their accounts from this:
*
* <ul>
* <li>Non-test-only DO/PO still can't be installed when there are accounts.
* <p>In order to make an apk test-only, add android:testOnly="true" to the
* <application> tag in the manifest.
*
* <li>Test-only DO/PO can be installed even when there are accounts, as long as all the
* accounts have the {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} feature.
* Some authenticators claim to have any features, so to detect it, we also check
* {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED} and disallow installing
* if any of the accounts have it.
* </ul>
*/
@SystemApi
@TestApi
public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED =
"android.account.DEVICE_OR_PROFILE_OWNER_ALLOWED";
/** @hide See {@link #ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_ALLOWED} */
@SystemApi
@TestApi
public static final String ACCOUNT_FEATURE_DEVICE_OR_PROFILE_OWNER_DISALLOWED =
"android.account.DEVICE_OR_PROFILE_OWNER_DISALLOWED";
/**
* Called by an application that is administering the device to set the password restrictions it
* is imposing. After setting this, the user will not be able to enter a new password that is
* not at least as restrictive as what has been set. Note that the current password will remain
* until the user has set a new one, so the change does not take place immediately. To prompt
* the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
* {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after calling this method.
* <p>
* Quality constants are ordered so that higher values are more restrictive; thus the highest
* requested quality constant (between the policy set here, the user's preference, and any other
* considerations) is the one that is in effect.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param quality The new desired quality. One of {@link #PASSWORD_QUALITY_UNSPECIFIED},
* {@link #PASSWORD_QUALITY_BIOMETRIC_WEAK},
* {@link #PASSWORD_QUALITY_SOMETHING}, {@link #PASSWORD_QUALITY_NUMERIC},
* {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
* {@link #PASSWORD_QUALITY_ALPHANUMERIC} or {@link #PASSWORD_QUALITY_COMPLEX}.
* @throws SecurityException if {@code admin} is not an active administrator or if {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
*/
public void setPasswordQuality(@NonNull ComponentName admin, int quality) {
if (mService != null) {
try {
mService.setPasswordQuality(admin, quality, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current minimum password quality for a particular admin or all admins that set
* restrictions on this user and its participating profiles. Restrictions on profiles that have
* a separate challenge are not taken into account.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* <p>Note: on devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature,
* the password is always treated as empty.
*
* @param admin The name of the admin component to check, or {@code null} to aggregate
* all admins.
*/
public int getPasswordQuality(@Nullable ComponentName admin) {
return getPasswordQuality(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
public int getPasswordQuality(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getPasswordQuality(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return PASSWORD_QUALITY_UNSPECIFIED;
}
/**
* Called by an application that is administering the device to set the minimum allowed password
* length. After setting this, the user will not be able to enter a new password that is not at
* least as restrictive as what has been set. Note that the current password will remain until
* the user has set a new one, so the change does not take place immediately. To prompt the user
* for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
* {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
* only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
* , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX}, {@link #PASSWORD_QUALITY_ALPHABETIC},
* {@link #PASSWORD_QUALITY_ALPHANUMERIC}, or {@link #PASSWORD_QUALITY_COMPLEX} with
* {@link #setPasswordQuality}.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param length The new desired minimum password length. A value of 0 means there is no
* restriction.
* @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
*/
public void setPasswordMinimumLength(@NonNull ComponentName admin, int length) {
if (mService != null) {
try {
mService.setPasswordMinimumLength(admin, length, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current minimum password length for a particular admin or all admins that set
* restrictions on this user and its participating profiles. Restrictions on profiles that have
* a separate challenge are not taken into account.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* @param admin The name of the admin component to check, or {@code null} to aggregate
* all admins.
*/
public int getPasswordMinimumLength(@Nullable ComponentName admin) {
return getPasswordMinimumLength(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
public int getPasswordMinimumLength(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getPasswordMinimumLength(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Called by an application that is administering the device to set the minimum number of upper
* case letters required in the password. After setting this, the user will not be able to enter
* a new password that is not at least as restrictive as what has been set. Note that the
* current password will remain until the user has set a new one, so the change does not take
* place immediately. To prompt the user for a new password, use
* {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
* setting this value. This constraint is only imposed if the administrator has also requested
* {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param length The new desired minimum number of upper case letters required in the password.
* A value of 0 means there is no restriction.
* @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
*/
public void setPasswordMinimumUpperCase(@NonNull ComponentName admin, int length) {
if (mService != null) {
try {
mService.setPasswordMinimumUpperCase(admin, length, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current number of upper case letters required in the password
* for a particular admin or all admins that set restrictions on this user and
* its participating profiles. Restrictions on profiles that have a separate challenge
* are not taken into account.
* This is the same value as set by
* {@link #setPasswordMinimumUpperCase(ComponentName, int)}
* and only applies when the password quality is
* {@link #PASSWORD_QUALITY_COMPLEX}.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* @param admin The name of the admin component to check, or {@code null} to
* aggregate all admins.
* @return The minimum number of upper case letters required in the
* password.
*/
public int getPasswordMinimumUpperCase(@Nullable ComponentName admin) {
return getPasswordMinimumUpperCase(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
public int getPasswordMinimumUpperCase(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getPasswordMinimumUpperCase(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Called by an application that is administering the device to set the minimum number of lower
* case letters required in the password. After setting this, the user will not be able to enter
* a new password that is not at least as restrictive as what has been set. Note that the
* current password will remain until the user has set a new one, so the change does not take
* place immediately. To prompt the user for a new password, use
* {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
* setting this value. This constraint is only imposed if the administrator has also requested
* {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param length The new desired minimum number of lower case letters required in the password.
* A value of 0 means there is no restriction.
* @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
*/
public void setPasswordMinimumLowerCase(@NonNull ComponentName admin, int length) {
if (mService != null) {
try {
mService.setPasswordMinimumLowerCase(admin, length, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current number of lower case letters required in the password
* for a particular admin or all admins that set restrictions on this user
* and its participating profiles. Restrictions on profiles that have
* a separate challenge are not taken into account.
* This is the same value as set by
* {@link #setPasswordMinimumLowerCase(ComponentName, int)}
* and only applies when the password quality is
* {@link #PASSWORD_QUALITY_COMPLEX}.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* @param admin The name of the admin component to check, or {@code null} to
* aggregate all admins.
* @return The minimum number of lower case letters required in the
* password.
*/
public int getPasswordMinimumLowerCase(@Nullable ComponentName admin) {
return getPasswordMinimumLowerCase(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
public int getPasswordMinimumLowerCase(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getPasswordMinimumLowerCase(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Called by an application that is administering the device to set the minimum number of
* letters required in the password. After setting this, the user will not be able to enter a
* new password that is not at least as restrictive as what has been set. Note that the current
* password will remain until the user has set a new one, so the change does not take place
* immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
* {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
* only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
* {@link #setPasswordQuality}. The default value is 1.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param length The new desired minimum number of letters required in the password. A value of
* 0 means there is no restriction.
* @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
*/
public void setPasswordMinimumLetters(@NonNull ComponentName admin, int length) {
if (mService != null) {
try {
mService.setPasswordMinimumLetters(admin, length, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current number of letters required in the password
* for a particular admin or all admins that set restrictions on this user
* and its participating profiles. Restrictions on profiles that have
* a separate challenge are not taken into account.
* This is the same value as set by
* {@link #setPasswordMinimumLetters(ComponentName, int)}
* and only applies when the password quality is
* {@link #PASSWORD_QUALITY_COMPLEX}.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* @param admin The name of the admin component to check, or {@code null} to
* aggregate all admins.
* @return The minimum number of letters required in the password.
*/
public int getPasswordMinimumLetters(@Nullable ComponentName admin) {
return getPasswordMinimumLetters(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
public int getPasswordMinimumLetters(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getPasswordMinimumLetters(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Called by an application that is administering the device to set the minimum number of
* numerical digits required in the password. After setting this, the user will not be able to
* enter a new password that is not at least as restrictive as what has been set. Note that the
* current password will remain until the user has set a new one, so the change does not take
* place immediately. To prompt the user for a new password, use
* {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
* setting this value. This constraint is only imposed if the administrator has also requested
* {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 1.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param length The new desired minimum number of numerical digits required in the password. A
* value of 0 means there is no restriction.
* @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
*/
public void setPasswordMinimumNumeric(@NonNull ComponentName admin, int length) {
if (mService != null) {
try {
mService.setPasswordMinimumNumeric(admin, length, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current number of numerical digits required in the password
* for a particular admin or all admins that set restrictions on this user
* and its participating profiles. Restrictions on profiles that have
* a separate challenge are not taken into account.
* This is the same value as set by
* {@link #setPasswordMinimumNumeric(ComponentName, int)}
* and only applies when the password quality is
* {@link #PASSWORD_QUALITY_COMPLEX}.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* @param admin The name of the admin component to check, or {@code null} to
* aggregate all admins.
* @return The minimum number of numerical digits required in the password.
*/
public int getPasswordMinimumNumeric(@Nullable ComponentName admin) {
return getPasswordMinimumNumeric(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
public int getPasswordMinimumNumeric(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getPasswordMinimumNumeric(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Called by an application that is administering the device to set the minimum number of
* symbols required in the password. After setting this, the user will not be able to enter a
* new password that is not at least as restrictive as what has been set. Note that the current
* password will remain until the user has set a new one, so the change does not take place
* immediately. To prompt the user for a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
* {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
* only imposed if the administrator has also requested {@link #PASSWORD_QUALITY_COMPLEX} with
* {@link #setPasswordQuality}. The default value is 1.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param length The new desired minimum number of symbols required in the password. A value of
* 0 means there is no restriction.
* @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
*/
public void setPasswordMinimumSymbols(@NonNull ComponentName admin, int length) {
if (mService != null) {
try {
mService.setPasswordMinimumSymbols(admin, length, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current number of symbols required in the password
* for a particular admin or all admins that set restrictions on this user
* and its participating profiles. Restrictions on profiles that have
* a separate challenge are not taken into account. This is the same value as
* set by {@link #setPasswordMinimumSymbols(ComponentName, int)}
* and only applies when the password quality is
* {@link #PASSWORD_QUALITY_COMPLEX}.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* @param admin The name of the admin component to check, or {@code null} to
* aggregate all admins.
* @return The minimum number of symbols required in the password.
*/
public int getPasswordMinimumSymbols(@Nullable ComponentName admin) {
return getPasswordMinimumSymbols(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
public int getPasswordMinimumSymbols(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getPasswordMinimumSymbols(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Called by an application that is administering the device to set the minimum number of
* non-letter characters (numerical digits or symbols) required in the password. After setting
* this, the user will not be able to enter a new password that is not at least as restrictive
* as what has been set. Note that the current password will remain until the user has set a new
* one, so the change does not take place immediately. To prompt the user for a new password,
* use {@link #ACTION_SET_NEW_PASSWORD} or {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after
* setting this value. This constraint is only imposed if the administrator has also requested
* {@link #PASSWORD_QUALITY_COMPLEX} with {@link #setPasswordQuality}. The default value is 0.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param length The new desired minimum number of letters required in the password. A value of
* 0 means there is no restriction.
* @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
*/
public void setPasswordMinimumNonLetter(@NonNull ComponentName admin, int length) {
if (mService != null) {
try {
mService.setPasswordMinimumNonLetter(admin, length, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current number of non-letter characters required in the password
* for a particular admin or all admins that set restrictions on this user
* and its participating profiles. Restrictions on profiles that have
* a separate challenge are not taken into account.
* This is the same value as set by
* {@link #setPasswordMinimumNonLetter(ComponentName, int)}
* and only applies when the password quality is
* {@link #PASSWORD_QUALITY_COMPLEX}.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* @param admin The name of the admin component to check, or {@code null} to
* aggregate all admins.
* @return The minimum number of letters required in the password.
*/
public int getPasswordMinimumNonLetter(@Nullable ComponentName admin) {
return getPasswordMinimumNonLetter(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
public int getPasswordMinimumNonLetter(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getPasswordMinimumNonLetter(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Called by an application that is administering the device to set the length of the password
* history. After setting this, the user will not be able to enter a new password that is the
* same as any password in the history. Note that the current password will remain until the
* user has set a new one, so the change does not take place immediately. To prompt the user for
* a new password, use {@link #ACTION_SET_NEW_PASSWORD} or
* {@link #ACTION_SET_NEW_PARENT_PROFILE_PASSWORD} after setting this value. This constraint is
* only imposed if the administrator has also requested either {@link #PASSWORD_QUALITY_NUMERIC}
* , {@link #PASSWORD_QUALITY_NUMERIC_COMPLEX} {@link #PASSWORD_QUALITY_ALPHABETIC}, or
* {@link #PASSWORD_QUALITY_ALPHANUMERIC} with {@link #setPasswordQuality}.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password history length is always 0.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param length The new desired length of password history. A value of 0 means there is no
* restriction.
* @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void setPasswordHistoryLength(@NonNull ComponentName admin, int length) {
if (mService != null) {
try {
mService.setPasswordHistoryLength(admin, length, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a device admin to set the password expiration timeout. Calling this method will
* restart the countdown for password expiration for the given admin, as will changing the
* device password (for all admins).
* <p>
* The provided timeout is the time delta in ms and will be added to the current time. For
* example, to have the password expire 5 days from now, timeout would be 5 * 86400 * 1000 =
* 432000000 ms for timeout.
* <p>
* To disable password expiration, a value of 0 may be used for timeout.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password expiration is always disabled.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
* <p>
* Note that setting the password will automatically reset the expiration time for all active
* admins. Active admins do not need to explicitly call this method in that case.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param timeout The limit (in ms) that a password can remain in effect. A value of 0 means
* there is no restriction (unlimited).
* @throws SecurityException if {@code admin} is not an active administrator or {@code admin}
* does not use {@link DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD}
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void setPasswordExpirationTimeout(@NonNull ComponentName admin, long timeout) {
if (mService != null) {
try {
mService.setPasswordExpirationTimeout(admin, timeout, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Get the password expiration timeout for the given admin. The expiration timeout is the
* recurring expiration timeout provided in the call to
* {@link #setPasswordExpirationTimeout(ComponentName, long)} for the given admin or the
* aggregate of all participating policy administrators if {@code admin} is null. Admins that
* have set restrictions on profiles that have a separate challenge are not taken into account.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password expiration is always disabled and this method always returns 0.
*
* @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
* @return The timeout for the given admin or the minimum of all timeouts
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public long getPasswordExpirationTimeout(@Nullable ComponentName admin) {
if (mService != null) {
try {
return mService.getPasswordExpirationTimeout(admin, myUserId(), mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Get the current password expiration time for a particular admin or all admins that set
* restrictions on this user and its participating profiles. Restrictions on profiles that have
* a separate challenge are not taken into account. If admin is {@code null}, then a composite
* of all expiration times is returned - which will be the minimum of all of them.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* the password expiration for the parent profile.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password expiration is always disabled and this method always returns 0.
*
* @param admin The name of the admin component to check, or {@code null} to aggregate all admins.
* @return The password expiration time, in milliseconds since epoch.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public long getPasswordExpiration(@Nullable ComponentName admin) {
if (mService != null) {
try {
return mService.getPasswordExpiration(admin, myUserId(), mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Retrieve the current password history length for a particular admin or all admins that
* set restrictions on this user and its participating profiles. Restrictions on profiles that
* have a separate challenge are not taken into account.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password history length is always 0.
*
* @param admin The name of the admin component to check, or {@code null} to aggregate
* all admins.
* @return The length of the password history
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public int getPasswordHistoryLength(@Nullable ComponentName admin) {
return getPasswordHistoryLength(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public int getPasswordHistoryLength(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getPasswordHistoryLength(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Return the maximum password length that the device supports for a
* particular password quality.
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always empty and this method always returns 0.
* @param quality The quality being interrogated.
* @return Returns the maximum length that the user can enter.
*/
public int getPasswordMaximumLength(int quality) {
PackageManager pm = mContext.getPackageManager();
if (!pm.hasSystemFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)) {
return 0;
}
// Kind-of arbitrary.
return 16;
}
/**
* Determines whether the calling user's current password meets policy requirements
* (e.g. quality, minimum length). The user must be unlocked to perform this check.
*
* <p>Policy requirements which affect this check can be set by admins of the user, but also
* by the admin of a managed profile associated with the calling user (when the managed profile
* doesn't have a separate work challenge). When a managed profile has a separate work
* challenge, its policy requirements only affect the managed profile.
*
* <p>Depending on the user, this method checks the policy requirement against one of the
* following passwords:
* <ul>
* <li>For the primary user or secondary users: the personal keyguard password.
* <li>For managed profiles: a work challenge if set, otherwise the parent user's personal
* keyguard password.
* <ul/>
* In other words, it's always checking the requirement against the password that is protecting
* the calling user.
*
* <p>Note that this method considers all policy requirements targeting the password in
* question. For example a profile owner might set a requirement on the parent profile i.e.
* personal keyguard but not on the profile itself. When the device has a weak personal keyguard
* password and no separate work challenge, calling this method will return {@code false}
* despite the profile owner not setting a policy on the profile itself. This is because the
* profile's current password is the personal keyguard password, and it does not meet all policy
* requirements.
*
* <p>Device admins must request {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD} before
* calling this method. Note, this policy type is deprecated for device admins in Android 9.0
* (API level 28) or higher.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to determine if the password set on
* the parent profile is sufficient.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always treated as empty - i.e. this method will always return false on such
* devices, provided any password requirements were set.
*
* @return {@code true} if the password meets the policy requirements, {@code false} otherwise
* @throws SecurityException if the calling application isn't an active admin that uses
* {@link DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD}
* @throws IllegalStateException if the user isn't unlocked
*/
public boolean isActivePasswordSufficient() {
if (mService != null) {
try {
return mService.isActivePasswordSufficient(myUserId(), mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Returns how complex the current user's screen lock is.
*
* <p>Note that when called from a profile which uses an unified challenge with its parent, the
* screen lock complexity of the parent will be returned. However, this API does not support
* explicitly querying the parent profile screen lock complexity via {@link
* #getParentProfileInstance}.
*
* @throws IllegalStateException if the user is not unlocked.
* @throws SecurityException if the calling application does not have the permission
* {@link permission#REQUEST_PASSWORD_COMPLEXITY}
*/
@PasswordComplexity
@RequiresPermission(android.Manifest.permission.REQUEST_PASSWORD_COMPLEXITY)
public int getPasswordComplexity() {
throwIfParentInstance("getPasswordComplexity");
if (mService == null) {
return PASSWORD_COMPLEXITY_NONE;
}
try {
return mService.getPasswordComplexity();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* When called by a profile owner of a managed profile returns true if the profile uses unified
* challenge with its parent user.
*
* <strong>Note</strong>: This method is not concerned with password quality and will return
* false if the profile has empty password as a separate challenge.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not a profile owner of a managed profile.
* @see UserManager#DISALLOW_UNIFIED_PASSWORD
*/
public boolean isUsingUnifiedPassword(@NonNull ComponentName admin) {
throwIfParentInstance("isUsingUnifiedPassword");
if (mService != null) {
try {
return mService.isUsingUnifiedPassword(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return true;
}
/**
* Determine whether the current profile password the user has set is sufficient
* to meet the policy requirements (e.g. quality, minimum length) that have been
* requested by the admins of the parent user and its profiles.
*
* @param userHandle the userId of the profile to check the password for.
* @return Returns true if the password would meet the current requirements, else false.
* @throws SecurityException if {@code userHandle} is not a managed profile.
* @hide
*/
public boolean isProfileActivePasswordSufficientForParent(int userHandle) {
if (mService != null) {
try {
return mService.isProfileActivePasswordSufficientForParent(userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Retrieve the number of times the user has failed at entering a password since that last
* successful password entry.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to retrieve the number of failed
* password attemts for the parent user.
* <p>
* The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
* to be able to call this method; if it has not, a security exception will be thrown.
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always empty and this method always returns 0.
*
* @return The number of times user has entered an incorrect password since the last correct
* password entry.
* @throws SecurityException if the calling application does not own an active administrator
* that uses {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN}
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public int getCurrentFailedPasswordAttempts() {
return getCurrentFailedPasswordAttempts(myUserId());
}
/**
* Retrieve the number of times the given user has failed at entering a
* password since that last successful password entry.
*
* <p>The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} to be able to call this method; if it has
* not and it is not the system uid, a security exception will be thrown.
*
* @hide
*/
@UnsupportedAppUsage
public int getCurrentFailedPasswordAttempts(int userHandle) {
if (mService != null) {
try {
return mService.getCurrentFailedPasswordAttempts(userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return -1;
}
/**
* Queries whether {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT} flag is set.
*
* @return true if RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT flag is set.
* @hide
*/
public boolean getDoNotAskCredentialsOnBoot() {
if (mService != null) {
try {
return mService.getDoNotAskCredentialsOnBoot();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Setting this to a value greater than zero enables a built-in policy that will perform a
* device or profile wipe after too many incorrect device-unlock passwords have been entered.
* This built-in policy combines watching for failed passwords and wiping the device, and
* requires that you request both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
* {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}}.
* <p>
* To implement any other policy (e.g. wiping data for a particular application only, erasing or
* revoking credentials, or reporting the failure to a server), you should implement
* {@link DeviceAdminReceiver#onPasswordFailed(Context, android.content.Intent)} instead. Do not
* use this API, because if the maximum count is reached, the device or profile will be wiped
* immediately, and your callback will not be invoked.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set a value on the parent
* profile.
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always empty and this method has no effect - i.e. the policy is not set.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param num The number of failed password attempts at which point the device or profile will
* be wiped.
* @throws SecurityException if {@code admin} is not an active administrator or does not use
* both {@link DeviceAdminInfo#USES_POLICY_WATCH_LOGIN} and
* {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void setMaximumFailedPasswordsForWipe(@NonNull ComponentName admin, int num) {
if (mService != null) {
try {
mService.setMaximumFailedPasswordsForWipe(admin, num, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current maximum number of login attempts that are allowed before the device
* or profile is wiped, for a particular admin or all admins that set restrictions on this user
* and its participating profiles. Restrictions on profiles that have a separate challenge are
* not taken into account.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* the value for the parent profile.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* password is always empty and this method returns a default value (0) indicating that the
* policy is not set.
*
* @param admin The name of the admin component to check, or {@code null} to aggregate
* all admins.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin) {
return getMaximumFailedPasswordsForWipe(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public int getMaximumFailedPasswordsForWipe(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getMaximumFailedPasswordsForWipe(
admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Returns the profile with the smallest maximum failed passwords for wipe,
* for the given user. So for primary user, it might return the primary or
* a managed profile. For a secondary user, it would be the same as the
* user passed in.
* @hide Used only by Keyguard
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public int getProfileWithMinimumFailedPasswordsForWipe(int userHandle) {
if (mService != null) {
try {
return mService.getProfileWithMinimumFailedPasswordsForWipe(
userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return UserHandle.USER_NULL;
}
/**
* Flag for {@link #resetPasswordWithToken} and {@link #resetPassword}: don't allow other admins
* to change the password again until the user has entered it.
*/
public static final int RESET_PASSWORD_REQUIRE_ENTRY = 0x0001;
/**
* Flag for {@link #resetPasswordWithToken} and {@link #resetPassword}: don't ask for user
* credentials on device boot.
* If the flag is set, the device can be booted without asking for user password.
* The absence of this flag does not change the current boot requirements. This flag
* can be set by the device owner only. If the app is not the device owner, the flag
* is ignored. Once the flag is set, it cannot be reverted back without resetting the
* device to factory defaults.
*/
public static final int RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT = 0x0002;
/**
* Force a new password for device unlock (the password needed to access the entire device) or
* the work profile challenge on the current user. This takes effect immediately.
* <p>
* <em>For device owner and profile owners targeting SDK level
* {@link android.os.Build.VERSION_CODES#O} or above, this API is no longer available and will
* throw {@link SecurityException}. Please use the new API {@link #resetPasswordWithToken}
* instead. </em>
* <p>
* <em>Note: This API has been limited as of {@link android.os.Build.VERSION_CODES#N} for
* device admins that are not device owner and not profile owner.
* The password can now only be changed if there is currently no password set. Device owner
* and profile owner can still do this when user is unlocked and does not have a managed
* profile.</em>
* <p>
* The given password must be sufficient for the current password quality and length constraints
* as returned by {@link #getPasswordQuality(ComponentName)} and
* {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
* it will be rejected and false returned. Note that the password may be a stronger quality
* (containing alphanumeric characters when the requested quality is only numeric), in which
* case the currently active quality will be increased to match.
* <p>
* Calling with a null or empty password will clear any existing PIN, pattern or password if the
* current password constraints allow it. <em>Note: This will not work in
* {@link android.os.Build.VERSION_CODES#N} and later for managed profiles, or for device admins
* that are not device owner or profile owner. Once set, the password cannot be changed to null
* or empty except by these admins.</em>
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, this
* methods does nothing.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD} to be able to call this method; if it has
* not, a security exception will be thrown.
*
* @param password The new password for the user. Null or empty clears the password.
* @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
* {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
* @return Returns true if the password was applied, or false if it is not acceptable for the
* current constraints or if the user has not been decrypted yet.
* @throws SecurityException if the calling application does not own an active administrator
* that uses {@link DeviceAdminInfo#USES_POLICY_RESET_PASSWORD}
* @throws IllegalStateException if the calling user is locked or has a managed profile.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public boolean resetPassword(String password, int flags) {
throwIfParentInstance("resetPassword");
if (mService != null) {
try {
return mService.resetPassword(password, flags);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by a profile or device owner to provision a token which can later be used to reset the
* device lockscreen password (if called by device owner), or managed profile challenge (if
* called by profile owner), via {@link #resetPasswordWithToken}.
* <p>
* If the user currently has a lockscreen password, the provisioned token will not be
* immediately usable; it only becomes active after the user performs a confirm credential
* operation, which can be triggered by {@link KeyguardManager#createConfirmDeviceCredentialIntent}.
* If the user has no lockscreen password, the token is activated immediately. In all cases,
* the active state of the current token can be checked by {@link #isResetPasswordTokenActive}.
* For security reasons, un-activated tokens are only stored in memory and will be lost once
* the device reboots. In this case a new token needs to be provisioned again.
* <p>
* Once provisioned and activated, the token will remain effective even if the user changes
* or clears the lockscreen password.
* <p>
* <em>This token is highly sensitive and should be treated at the same level as user
* credentials. In particular, NEVER store this token on device in plaintext. Do not store
* the plaintext token in device-encrypted storage if it will be needed to reset password on
* file-based encryption devices before user unlocks. Consider carefully how any password token
* will be stored on your server and who will need access to them. Tokens may be the subject of
* legal access requests.
* </em>
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, the
* reset token is not set and this method returns false.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param token a secure token a least 32-byte long, which must be generated by a
* cryptographically strong random number generator.
* @return true if the operation is successful, false otherwise.
* @throws SecurityException if admin is not a device or profile owner.
* @throws IllegalArgumentException if the supplied token is invalid.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public boolean setResetPasswordToken(ComponentName admin, byte[] token) {
throwIfParentInstance("setResetPasswordToken");
if (mService != null) {
try {
return mService.setResetPasswordToken(admin, token);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by a profile or device owner to revoke the current password reset token.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, this
* method has no effect - the reset token should not have been set in the first place - and
* false is returned.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return true if the operation is successful, false otherwise.
* @throws SecurityException if admin is not a device or profile owner.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public boolean clearResetPasswordToken(ComponentName admin) {
throwIfParentInstance("clearResetPasswordToken");
if (mService != null) {
try {
return mService.clearResetPasswordToken(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by a profile or device owner to check if the current reset password token is active.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature,
* false is always returned.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return true if the token is active, false otherwise.
* @throws SecurityException if admin is not a device or profile owner.
* @throws IllegalStateException if no token has been set.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public boolean isResetPasswordTokenActive(ComponentName admin) {
throwIfParentInstance("isResetPasswordTokenActive");
if (mService != null) {
try {
return mService.isResetPasswordTokenActive(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by device or profile owner to force set a new device unlock password or a managed
* profile challenge on current user. This takes effect immediately.
* <p>
* Unlike {@link #resetPassword}, this API can change the password even before the user or
* device is unlocked or decrypted. The supplied token must have been previously provisioned via
* {@link #setResetPasswordToken}, and in active state {@link #isResetPasswordTokenActive}.
* <p>
* The given password must be sufficient for the current password quality and length constraints
* as returned by {@link #getPasswordQuality(ComponentName)} and
* {@link #getPasswordMinimumLength(ComponentName)}; if it does not meet these constraints, then
* it will be rejected and false returned. Note that the password may be a stronger quality, for
* example, a password containing alphanumeric characters when the requested quality is only
* numeric.
* <p>
* Calling with a {@code null} or empty password will clear any existing PIN, pattern or
* password if the current password constraints allow it.
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature,
* calling this methods has no effect - the password is always empty - and false is returned.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param password The new password for the user. {@code null} or empty clears the password.
* @param token the password reset token previously provisioned by
* {@link #setResetPasswordToken}.
* @param flags May be 0 or combination of {@link #RESET_PASSWORD_REQUIRE_ENTRY} and
* {@link #RESET_PASSWORD_DO_NOT_ASK_CREDENTIALS_ON_BOOT}.
* @return Returns true if the password was applied, or false if it is not acceptable for the
* current constraints.
* @throws SecurityException if admin is not a device or profile owner.
* @throws IllegalStateException if the provided token is not valid.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public boolean resetPasswordWithToken(@NonNull ComponentName admin, String password,
byte[] token, int flags) {
throwIfParentInstance("resetPassword");
if (mService != null) {
try {
return mService.resetPasswordWithToken(admin, password, token, flags);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by an application that is administering the device to set the maximum time for user
* activity until the device will lock. This limits the length that the user can set. It takes
* effect immediately.
* <p>
* The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
* to be able to call this method; if it has not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param timeMs The new desired maximum time to lock in milliseconds. A value of 0 means there
* is no restriction.
* @throws SecurityException if {@code admin} is not an active administrator or it does not use
* {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
*/
public void setMaximumTimeToLock(@NonNull ComponentName admin, long timeMs) {
if (mService != null) {
try {
mService.setMaximumTimeToLock(admin, timeMs, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Retrieve the current maximum time to unlock for a particular admin or all admins that set
* restrictions on this user and its participating profiles. Restrictions on profiles that have
* a separate challenge are not taken into account.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* @param admin The name of the admin component to check, or {@code null} to aggregate
* all admins.
* @return time in milliseconds for the given admin or the minimum value (strictest) of
* all admins if admin is null. Returns 0 if there are no restrictions.
*/
public long getMaximumTimeToLock(@Nullable ComponentName admin) {
return getMaximumTimeToLock(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage
public long getMaximumTimeToLock(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getMaximumTimeToLock(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Called by a device/profile owner to set the timeout after which unlocking with secondary, non
* strong auth (e.g. fingerprint, face, trust agents) times out, i.e. the user has to use a
* strong authentication method like password, pin or pattern.
*
* <p>This timeout is used internally to reset the timer to require strong auth again after
* specified timeout each time it has been successfully used.
*
* <p>Fingerprint can also be disabled altogether using {@link #KEYGUARD_DISABLE_FINGERPRINT}.
*
* <p>Trust agents can also be disabled altogether using {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
*
* <p>The calling device admin must be a device or profile owner. If it is not,
* a {@link SecurityException} will be thrown.
*
* <p>The calling device admin can verify the value it has set by calling
* {@link #getRequiredStrongAuthTimeout(ComponentName)} and passing in its instance.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature,
* calling this methods has no effect - i.e. the timeout is not set.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param timeoutMs The new timeout in milliseconds, after which the user will have to unlock
* with strong authentication method. A value of 0 means the admin is not participating
* in controlling the timeout.
* The minimum and maximum timeouts are platform-defined and are typically 1 hour and
* 72 hours, respectively. Though discouraged, the admin may choose to require strong
* auth at all times using {@link #KEYGUARD_DISABLE_FINGERPRINT} and/or
* {@link #KEYGUARD_DISABLE_TRUST_AGENTS}.
*
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void setRequiredStrongAuthTimeout(@NonNull ComponentName admin,
long timeoutMs) {
if (mService != null) {
try {
mService.setRequiredStrongAuthTimeout(admin, timeoutMs, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Determine for how long the user will be able to use secondary, non strong auth for
* authentication, since last strong method authentication (password, pin or pattern) was used.
* After the returned timeout the user is required to use strong authentication method.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* <p>On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature,
* 0 is returned to indicate that no timeout is configured.
*
* @param admin The name of the admin component to check, or {@code null} to aggregate
* across all participating admins.
* @return The timeout in milliseconds or 0 if not configured for the provided admin.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin) {
return getRequiredStrongAuthTimeout(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public long getRequiredStrongAuthTimeout(@Nullable ComponentName admin, @UserIdInt int userId) {
if (mService != null) {
try {
return mService.getRequiredStrongAuthTimeout(admin, userId, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return DEFAULT_STRONG_AUTH_TIMEOUT_MS;
}
/**
* Flag for {@link #lockNow(int)}: also evict the user's credential encryption key from the
* keyring. The user's credential will need to be entered again in order to derive the
* credential encryption key that will be stored back in the keyring for future use.
* <p>
* This flag can only be used by a profile owner when locking a managed profile when
* {@link #getStorageEncryptionStatus} returns {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
* <p>
* In order to secure user data, the user will be stopped and restarted so apps should wait
* until they are next run to perform further actions.
*/
public static final int FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY = 1;
/** @hide */
@Retention(RetentionPolicy.SOURCE)
@IntDef(flag = true, prefix = { "FLAG_EVICT_" }, value = {
FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY
})
public @interface LockNowFlag {}
/**
* Make the device lock immediately, as if the lock screen timeout has expired at the point of
* this call.
* <p>
* This method secures the device in response to an urgent situation, such as a lost or stolen
* device. After this method is called, the device must be unlocked using strong authentication
* (PIN, pattern, or password). This API is intended for use only by device admins.
* <p>
* The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
* to be able to call this method; if it has not, a security exception will be thrown.
* <p>
* If there's no lock type set, this method forces the device to go to sleep but doesn't lock
* the device. Device admins who find the device in this state can lock an otherwise-insecure
* device by first calling {@link #resetPassword} to set the password and then lock the device.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
* <p>
* Equivalent to calling {@link #lockNow(int)} with no flags.
*
* @throws SecurityException if the calling application does not own an active administrator
* that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
*/
public void lockNow() {
lockNow(0);
}
/**
* Make the device lock immediately, as if the lock screen timeout has expired at the point of
* this call.
* <p>
* This method secures the device in response to an urgent situation, such as a lost or stolen
* device. After this method is called, the device must be unlocked using strong authentication
* (PIN, pattern, or password). This API is intended for use only by device admins.
* <p>
* The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK}
* to be able to call this method; if it has not, a security exception will be thrown.
* <p>
* If there's no lock type set, this method forces the device to go to sleep but doesn't lock
* the device. Device admins who find the device in this state can lock an otherwise-insecure
* device by first calling {@link #resetPassword} to set the password and then lock the device.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to lock the parent profile.
*
* @param flags May be 0 or {@link #FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY}.
* @throws SecurityException if the calling application does not own an active administrator
* that uses {@link DeviceAdminInfo#USES_POLICY_FORCE_LOCK} or the
* {@link #FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY} flag is passed by an application
* that is not a profile
* owner of a managed profile.
* @throws IllegalArgumentException if the {@link #FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY} flag is
* passed when locking the parent profile.
* @throws UnsupportedOperationException if the {@link #FLAG_EVICT_CREDENTIAL_ENCRYPTION_KEY}
* flag is passed when {@link #getStorageEncryptionStatus} does not return
* {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
*/
public void lockNow(@LockNowFlag int flags) {
if (mService != null) {
try {
mService.lockNow(flags, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Flag for {@link #wipeData(int)}: also erase the device's external
* storage (such as SD cards).
*/
public static final int WIPE_EXTERNAL_STORAGE = 0x0001;
/**
* Flag for {@link #wipeData(int)}: also erase the factory reset protection
* data.
*
* <p>This flag may only be set by device owner admins; if it is set by
* other admins a {@link SecurityException} will be thrown.
*/
public static final int WIPE_RESET_PROTECTION_DATA = 0x0002;
/**
* Flag for {@link #wipeData(int)}: also erase the device's eUICC data.
*/
public static final int WIPE_EUICC = 0x0004;
/**
* Flag for {@link #wipeData(int)}: won't show reason for wiping to the user.
*/
public static final int WIPE_SILENTLY = 0x0008;
/**
* Ask that all user data be wiped. If called as a secondary user, the user will be removed and
* other users will remain unaffected. Calling from the primary user will cause the device to
* reboot, erasing all device data - including all the secondary users and their data - while
* booting up.
* <p>
* The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
* be able to call this method; if it has not, a security exception will be thrown.
*
* @param flags Bit mask of additional options: currently supported flags are
* {@link #WIPE_EXTERNAL_STORAGE}, {@link #WIPE_RESET_PROTECTION_DATA},
* {@link #WIPE_EUICC} and {@link #WIPE_SILENTLY}.
* @throws SecurityException if the calling application does not own an active administrator
* that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
*/
public void wipeData(int flags) {
throwIfParentInstance("wipeData");
final String wipeReasonForUser = mContext.getString(
R.string.work_profile_deleted_description_dpm_wipe);
wipeDataInternal(flags, wipeReasonForUser);
}
/**
* Ask that all user data be wiped. If called as a secondary user, the user will be removed and
* other users will remain unaffected, the provided reason for wiping data can be shown to
* user. Calling from the primary user will cause the device to reboot, erasing all device data
* - including all the secondary users and their data - while booting up. In this case, we don't
* show the reason to the user since the device would be factory reset.
* <p>
* The calling device admin must have requested {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA} to
* be able to call this method; if it has not, a security exception will be thrown.
*
* @param flags Bit mask of additional options: currently supported flags are
* {@link #WIPE_EXTERNAL_STORAGE}, {@link #WIPE_RESET_PROTECTION_DATA} and
* {@link #WIPE_EUICC}.
* @param reason a string that contains the reason for wiping data, which can be
* presented to the user.
* @throws SecurityException if the calling application does not own an active administrator
* that uses {@link DeviceAdminInfo#USES_POLICY_WIPE_DATA}
* @throws IllegalArgumentException if the input reason string is null or empty, or if
* {@link #WIPE_SILENTLY} is set.
*/
public void wipeData(int flags, @NonNull CharSequence reason) {
throwIfParentInstance("wipeData");
Preconditions.checkNotNull(reason, "reason string is null");
Preconditions.checkStringNotEmpty(reason, "reason string is empty");
Preconditions.checkArgument((flags & WIPE_SILENTLY) == 0, "WIPE_SILENTLY cannot be set");
wipeDataInternal(flags, reason.toString());
}
/**
* Internal function for both {@link #wipeData(int)} and
* {@link #wipeData(int, CharSequence)} to call.
*
* @see #wipeData(int)
* @see #wipeData(int, CharSequence)
* @hide
*/
private void wipeDataInternal(int flags, @NonNull String wipeReasonForUser) {
if (mService != null) {
try {
mService.wipeDataWithReason(flags, wipeReasonForUser);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by an application that is administering the device to set the
* global proxy and exclusion list.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_SETS_GLOBAL_PROXY} to be able to call
* this method; if it has not, a security exception will be thrown.
* Only the first device admin can set the proxy. If a second admin attempts
* to set the proxy, the {@link ComponentName} of the admin originally setting the
* proxy will be returned. If successful in setting the proxy, {@code null} will
* be returned.
* The method can be called repeatedly by the device admin alrady setting the
* proxy to update the proxy and exclusion list.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param proxySpec the global proxy desired. Must be an HTTP Proxy.
* Pass Proxy.NO_PROXY to reset the proxy.
* @param exclusionList a list of domains to be excluded from the global proxy.
* @return {@code null} if the proxy was successfully set, or otherwise a {@link ComponentName}
* of the device admin that sets the proxy.
* @hide
*/
@UnsupportedAppUsage
public @Nullable ComponentName setGlobalProxy(@NonNull ComponentName admin, Proxy proxySpec,
List<String> exclusionList ) {
throwIfParentInstance("setGlobalProxy");
if (proxySpec == null) {
throw new NullPointerException();
}
if (mService != null) {
try {
String hostSpec;
String exclSpec;
if (proxySpec.equals(Proxy.NO_PROXY)) {
hostSpec = null;
exclSpec = null;
} else {
if (!proxySpec.type().equals(Proxy.Type.HTTP)) {
throw new IllegalArgumentException();
}
InetSocketAddress sa = (InetSocketAddress)proxySpec.address();
String hostName = sa.getHostName();
int port = sa.getPort();
StringBuilder hostBuilder = new StringBuilder();
hostSpec = hostBuilder.append(hostName)
.append(":").append(Integer.toString(port)).toString();
if (exclusionList == null) {
exclSpec = "";
} else {
StringBuilder listBuilder = new StringBuilder();
boolean firstDomain = true;
for (String exclDomain : exclusionList) {
if (!firstDomain) {
listBuilder = listBuilder.append(",");
} else {
firstDomain = false;
}
listBuilder = listBuilder.append(exclDomain.trim());
}
exclSpec = listBuilder.toString();
}
if (android.net.Proxy.validate(hostName, Integer.toString(port), exclSpec)
!= android.net.Proxy.PROXY_VALID)
throw new IllegalArgumentException();
}
return mService.setGlobalProxy(admin, hostSpec, exclSpec);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Set a network-independent global HTTP proxy. This is not normally what you want for typical
* HTTP proxies - they are generally network dependent. However if you're doing something
* unusual like general internal filtering this may be useful. On a private network where the
* proxy is not accessible, you may break HTTP using this.
* <p>
* This method requires the caller to be the device owner.
* <p>
* This proxy is only a recommendation and it is possible that some apps will ignore it.
*
* @see ProxyInfo
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param proxyInfo The a {@link ProxyInfo} object defining the new global HTTP proxy. A
* {@code null} value will clear the global HTTP proxy.
* @throws SecurityException if {@code admin} is not the device owner.
*/
public void setRecommendedGlobalProxy(@NonNull ComponentName admin, @Nullable ProxyInfo
proxyInfo) {
throwIfParentInstance("setRecommendedGlobalProxy");
if (mService != null) {
try {
mService.setRecommendedGlobalProxy(admin, proxyInfo);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Returns the component name setting the global proxy.
* @return ComponentName object of the device admin that set the global proxy, or {@code null}
* if no admin has set the proxy.
* @hide
*/
public @Nullable ComponentName getGlobalProxyAdmin() {
if (mService != null) {
try {
return mService.getGlobalProxyAdmin(myUserId());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
* indicating that encryption is not supported.
*/
public static final int ENCRYPTION_STATUS_UNSUPPORTED = 0;
/**
* Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
* indicating that encryption is supported, but is not currently active.
*/
public static final int ENCRYPTION_STATUS_INACTIVE = 1;
/**
* Result code for {@link #getStorageEncryptionStatus}:
* indicating that encryption is not currently active, but is currently
* being activated. This is only reported by devices that support
* encryption of data and only when the storage is currently
* undergoing a process of becoming encrypted. A device that must reboot and/or wipe data
* to become encrypted will never return this value.
*/
public static final int ENCRYPTION_STATUS_ACTIVATING = 2;
/**
* Result code for {@link #setStorageEncryption} and {@link #getStorageEncryptionStatus}:
* indicating that encryption is active.
* <p>
* Also see {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
*/
public static final int ENCRYPTION_STATUS_ACTIVE = 3;
/**
* Result code for {@link #getStorageEncryptionStatus}:
* indicating that encryption is active, but an encryption key has not
* been set by the user.
*/
public static final int ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY = 4;
/**
* Result code for {@link #getStorageEncryptionStatus}:
* indicating that encryption is active and the encryption key is tied to the user or profile.
* <p>
* This value is only returned to apps targeting API level 24 and above. For apps targeting
* earlier API levels, {@link #ENCRYPTION_STATUS_ACTIVE} is returned, even if the
* encryption key is specific to the user or profile.
*/
public static final int ENCRYPTION_STATUS_ACTIVE_PER_USER = 5;
/**
* Activity action: begin the process of encrypting data on the device. This activity should
* be launched after using {@link #setStorageEncryption} to request encryption be activated.
* After resuming from this activity, use {@link #getStorageEncryption}
* to check encryption status. However, on some devices this activity may never return, as
* it may trigger a reboot and in some cases a complete data wipe of the device.
*/
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_START_ENCRYPTION
= "android.app.action.START_ENCRYPTION";
/**
* Broadcast action: notify managed provisioning that new managed user is created.
*
* @hide
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_MANAGED_USER_CREATED =
"android.app.action.MANAGED_USER_CREATED";
/**
* Widgets are enabled in keyguard
*/
public static final int KEYGUARD_DISABLE_FEATURES_NONE = 0;
/**
* Disable all keyguard widgets. Has no effect starting from
* {@link android.os.Build.VERSION_CODES#LOLLIPOP} since keyguard widget is only supported
* on Android versions lower than 5.0.
*/
public static final int KEYGUARD_DISABLE_WIDGETS_ALL = 1 << 0;
/**
* Disable the camera on secure keyguard screens (e.g. PIN/Pattern/Password)
*/
public static final int KEYGUARD_DISABLE_SECURE_CAMERA = 1 << 1;
/**
* Disable showing all notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
*/
public static final int KEYGUARD_DISABLE_SECURE_NOTIFICATIONS = 1 << 2;
/**
* Only allow redacted notifications on secure keyguard screens (e.g. PIN/Pattern/Password)
*/
public static final int KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS = 1 << 3;
/**
* Disable trust agents on secure keyguard screens (e.g. PIN/Pattern/Password).
* By setting this flag alone, all trust agents are disabled. If the admin then wants to
* whitelist specific features of some trust agent, {@link #setTrustAgentConfiguration} can be
* used in conjuction to set trust-agent-specific configurations.
*/
public static final int KEYGUARD_DISABLE_TRUST_AGENTS = 1 << 4;
/**
* Disable fingerprint authentication on keyguard secure screens (e.g. PIN/Pattern/Password).
*/
public static final int KEYGUARD_DISABLE_FINGERPRINT = 1 << 5;
/**
* Disable text entry into notifications on secure keyguard screens (e.g. PIN/Pattern/Password).
* This flag has no effect starting from version {@link android.os.Build.VERSION_CODES#N}
*/
public static final int KEYGUARD_DISABLE_REMOTE_INPUT = 1 << 6;
/**
* Disable face authentication on keyguard secure screens (e.g. PIN/Pattern/Password).
*/
public static final int KEYGUARD_DISABLE_FACE = 1 << 7;
/**
* Disable iris authentication on keyguard secure screens (e.g. PIN/Pattern/Password).
*/
public static final int KEYGUARD_DISABLE_IRIS = 1 << 8;
/**
* NOTE: Please remember to update the DevicePolicyManagerTest's testKeyguardDisabledFeatures
* CTS test when adding to the list above.
*/
/**
* Disable all biometric authentication on keyguard secure screens (e.g. PIN/Pattern/Password).
*/
public static final int KEYGUARD_DISABLE_BIOMETRICS =
DevicePolicyManager.KEYGUARD_DISABLE_FACE
| DevicePolicyManager.KEYGUARD_DISABLE_IRIS
| DevicePolicyManager.KEYGUARD_DISABLE_FINGERPRINT;
/**
* Disable all current and future keyguard customizations.
*/
public static final int KEYGUARD_DISABLE_FEATURES_ALL = 0x7fffffff;
/**
* Keyguard features that when set on a managed profile that doesn't have its own challenge will
* affect the profile's parent user. These can also be set on the managed profile's parent
* {@link DevicePolicyManager} instance.
*
* @hide
*/
public static final int PROFILE_KEYGUARD_FEATURES_AFFECT_OWNER =
DevicePolicyManager.KEYGUARD_DISABLE_TRUST_AGENTS
| DevicePolicyManager.KEYGUARD_DISABLE_BIOMETRICS;
/**
* Called by an application that is administering the device to request that the storage system
* be encrypted. Does nothing if the caller is on a secondary user or a managed profile.
* <p>
* When multiple device administrators attempt to control device encryption, the most secure,
* supported setting will always be used. If any device administrator requests device
* encryption, it will be enabled; Conversely, if a device administrator attempts to disable
* device encryption while another device administrator has enabled it, the call to disable will
* fail (most commonly returning {@link #ENCRYPTION_STATUS_ACTIVE}).
* <p>
* This policy controls encryption of the secure (application data) storage area. Data written
* to other storage areas may or may not be encrypted, and this policy does not require or
* control the encryption of any other storage areas. There is one exception: If
* {@link android.os.Environment#isExternalStorageEmulated()} is {@code true}, then the
* directory returned by {@link android.os.Environment#getExternalStorageDirectory()} must be
* written to disk within the encrypted storage area.
* <p>
* Important Note: On some devices, it is possible to encrypt storage without requiring the user
* to create a device PIN or Password. In this case, the storage is encrypted, but the
* encryption key may not be fully secured. For maximum security, the administrator should also
* require (and check for) a pattern, PIN, or password.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param encrypt true to request encryption, false to release any previous request
* @return the new total request status (for all active admins), or {@link
* DevicePolicyManager#ENCRYPTION_STATUS_UNSUPPORTED} if called for a non-system user.
* Will be one of {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link
* #ENCRYPTION_STATUS_INACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE}. This is the value
* of the requests; use {@link #getStorageEncryptionStatus()} to query the actual device
* state.
*
* @throws SecurityException if {@code admin} is not an active administrator or does not use
* {@link DeviceAdminInfo#USES_ENCRYPTED_STORAGE}
*/
public int setStorageEncryption(@NonNull ComponentName admin, boolean encrypt) {
throwIfParentInstance("setStorageEncryption");
if (mService != null) {
try {
return mService.setStorageEncryption(admin, encrypt);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return ENCRYPTION_STATUS_UNSUPPORTED;
}
/**
* Called by an application that is administering the device to
* determine the requested setting for secure storage.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
* this will return the requested encryption setting as an aggregate of all active
* administrators.
* @return true if the admin(s) are requesting encryption, false if not.
*/
public boolean getStorageEncryption(@Nullable ComponentName admin) {
throwIfParentInstance("getStorageEncryption");
if (mService != null) {
try {
return mService.getStorageEncryption(admin, myUserId());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by an application that is administering the device to
* determine the current encryption status of the device.
* <p>
* Depending on the returned status code, the caller may proceed in different
* ways. If the result is {@link #ENCRYPTION_STATUS_UNSUPPORTED}, the
* storage system does not support encryption. If the
* result is {@link #ENCRYPTION_STATUS_INACTIVE}, use {@link
* #ACTION_START_ENCRYPTION} to begin the process of encrypting or decrypting the
* storage. If the result is {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY}, the
* storage system has enabled encryption but no password is set so further action
* may be required. If the result is {@link #ENCRYPTION_STATUS_ACTIVATING},
* {@link #ENCRYPTION_STATUS_ACTIVE} or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER},
* no further action is required.
*
* @return current status of encryption. The value will be one of
* {@link #ENCRYPTION_STATUS_UNSUPPORTED}, {@link #ENCRYPTION_STATUS_INACTIVE},
* {@link #ENCRYPTION_STATUS_ACTIVATING}, {@link #ENCRYPTION_STATUS_ACTIVE_DEFAULT_KEY},
* {@link #ENCRYPTION_STATUS_ACTIVE}, or {@link #ENCRYPTION_STATUS_ACTIVE_PER_USER}.
*/
public int getStorageEncryptionStatus() {
throwIfParentInstance("getStorageEncryptionStatus");
return getStorageEncryptionStatus(myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage
public int getStorageEncryptionStatus(int userHandle) {
if (mService != null) {
try {
return mService.getStorageEncryptionStatus(mContext.getPackageName(), userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return ENCRYPTION_STATUS_UNSUPPORTED;
}
/**
* Mark a CA certificate as approved by the device user. This means that they have been notified
* of the installation, were made aware of the risks, viewed the certificate and still wanted to
* keep the certificate on the device.
*
* Calling with {@param approval} as {@code true} will cancel any ongoing warnings related to
* this certificate.
*
* @hide
*/
public boolean approveCaCert(String alias, int userHandle, boolean approval) {
if (mService != null) {
try {
return mService.approveCaCert(alias, userHandle, approval);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Check whether a CA certificate has been approved by the device user.
*
* @hide
*/
public boolean isCaCertApproved(String alias, int userHandle) {
if (mService != null) {
try {
return mService.isCaCertApproved(alias, userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Installs the given certificate as a user CA.
* <p>
* Inserted user CAs aren't automatically trusted by apps in Android 7.0 (API level 24) and
* higher. App developers can change the default behavior for an app by adding a
* <a href="{@docRoot}training/articles/security-config.html">Security Configuration
* File</a> to the app manifest file.
*
* The caller must be a profile or device owner on that user, or a delegate package given the
* {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a
* security exception will be thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @param certBuffer encoded form of the certificate to install.
*
* @return false if the certBuffer cannot be parsed or installation is
* interrupted, true otherwise.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner.
* @see #setDelegatedScopes
* @see #DELEGATION_CERT_INSTALL
*/
public boolean installCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
throwIfParentInstance("installCaCert");
if (mService != null) {
try {
return mService.installCaCert(admin, mContext.getPackageName(), certBuffer);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Uninstalls the given certificate from trusted user CAs, if present.
*
* The caller must be a profile or device owner on that user, or a delegate package given the
* {@link #DELEGATION_CERT_INSTALL} scope via {@link #setDelegatedScopes}; otherwise a
* security exception will be thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @param certBuffer encoded form of the certificate to remove.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner.
* @see #setDelegatedScopes
* @see #DELEGATION_CERT_INSTALL
*/
public void uninstallCaCert(@Nullable ComponentName admin, byte[] certBuffer) {
throwIfParentInstance("uninstallCaCert");
if (mService != null) {
try {
final String alias = getCaCertAlias(certBuffer);
mService.uninstallCaCerts(admin, mContext.getPackageName(), new String[] {alias});
} catch (CertificateException e) {
Log.w(TAG, "Unable to parse certificate", e);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Returns all CA certificates that are currently trusted, excluding system CA certificates.
* If a user has installed any certificates by other means than device policy these will be
* included too.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @return a List of byte[] arrays, each encoding one user CA certificate.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner.
*/
public @NonNull List<byte[]> getInstalledCaCerts(@Nullable ComponentName admin) {
final List<byte[]> certs = new ArrayList<byte[]>();
throwIfParentInstance("getInstalledCaCerts");
if (mService != null) {
try {
mService.enforceCanManageCaCerts(admin, mContext.getPackageName());
final TrustedCertificateStore certStore = new TrustedCertificateStore();
for (String alias : certStore.userAliases()) {
try {
certs.add(certStore.getCertificate(alias).getEncoded());
} catch (CertificateException ce) {
Log.w(TAG, "Could not encode certificate: " + alias, ce);
}
}
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return certs;
}
/**
* Uninstalls all custom trusted CA certificates from the profile. Certificates installed by
* means other than device policy will also be removed, except for system CA certificates.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner.
*/
public void uninstallAllUserCaCerts(@Nullable ComponentName admin) {
throwIfParentInstance("uninstallAllUserCaCerts");
if (mService != null) {
try {
mService.uninstallCaCerts(admin, mContext.getPackageName(),
new TrustedCertificateStore().userAliases() .toArray(new String[0]));
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* Returns whether this certificate is installed as a trusted CA.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @param certBuffer encoded form of the certificate to look up.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner.
*/
public boolean hasCaCertInstalled(@Nullable ComponentName admin, byte[] certBuffer) {
throwIfParentInstance("hasCaCertInstalled");
if (mService != null) {
try {
mService.enforceCanManageCaCerts(admin, mContext.getPackageName());
return getCaCertAlias(certBuffer) != null;
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
} catch (CertificateException ce) {
Log.w(TAG, "Could not parse certificate", ce);
}
}
return false;
}
/**
* Called by a device or profile owner, or delegated certificate installer, to install a
* certificate and corresponding private key. All apps within the profile will be able to access
* the certificate and use the private key, given direct user approval.
*
* <p>Access to the installed credentials will not be granted to the caller of this API without
* direct user approval. This is for security - should a certificate installer become
* compromised, certificates it had already installed will be protected.
*
* <p>If the installer must have access to the credentials, call
* {@link #installKeyPair(ComponentName, PrivateKey, Certificate[], String, boolean)} instead.
*
* <p>Note: If the provided {@code alias} is of an existing alias, all former grants that apps
* have been given to access the key and certificates associated with this alias will be
* revoked.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @param privKey The private key to install.
* @param cert The certificate to install.
* @param alias The private key alias under which to install the certificate. If a certificate
* with that alias already exists, it will be overwritten.
* @return {@code true} if the keys were installed, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner.
* @see #setDelegatedScopes
* @see #DELEGATION_CERT_INSTALL
*/
public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
@NonNull Certificate cert, @NonNull String alias) {
return installKeyPair(admin, privKey, new Certificate[] {cert}, alias, false);
}
/**
* Called by a device or profile owner, or delegated certificate installer, to install a
* certificate chain and corresponding private key for the leaf certificate. All apps within the
* profile will be able to access the certificate chain and use the private key, given direct
* user approval.
*
* <p>The caller of this API may grant itself access to the certificate and private key
* immediately, without user approval. It is a best practice not to request this unless strictly
* necessary since it opens up additional security vulnerabilities.
*
* <p>Note: If the provided {@code alias} is of an existing alias, all former grants that apps
* have been given to access the key and certificates associated with this alias will be
* revoked.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @param privKey The private key to install.
* @param certs The certificate chain to install. The chain should start with the leaf
* certificate and include the chain of trust in order. This will be returned by
* {@link android.security.KeyChain#getCertificateChain}.
* @param alias The private key alias under which to install the certificate. If a certificate
* with that alias already exists, it will be overwritten.
* @param requestAccess {@code true} to request that the calling app be granted access to the
* credentials immediately. Otherwise, access to the credentials will be gated by user
* approval.
* @return {@code true} if the keys were installed, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner.
* @see android.security.KeyChain#getCertificateChain
* @see #setDelegatedScopes
* @see #DELEGATION_CERT_INSTALL
*/
public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
@NonNull Certificate[] certs, @NonNull String alias, boolean requestAccess) {
int flags = INSTALLKEY_SET_USER_SELECTABLE;
if (requestAccess) {
flags |= INSTALLKEY_REQUEST_CREDENTIALS_ACCESS;
}
return installKeyPair(admin, privKey, certs, alias, flags);
}
/**
* Called by a device or profile owner, or delegated certificate installer, to install a
* certificate chain and corresponding private key for the leaf certificate. All apps within the
* profile will be able to access the certificate chain and use the private key, given direct
* user approval (if the user is allowed to select the private key).
*
* <p>The caller of this API may grant itself access to the certificate and private key
* immediately, without user approval. It is a best practice not to request this unless strictly
* necessary since it opens up additional security vulnerabilities.
*
* <p>Include {@link #INSTALLKEY_SET_USER_SELECTABLE} in the {@code flags} argument to allow
* the user to select the key from a dialog.
*
* <p>Note: If the provided {@code alias} is of an existing alias, all former grants that apps
* have been given to access the key and certificates associated with this alias will be
* revoked.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @param privKey The private key to install.
* @param certs The certificate chain to install. The chain should start with the leaf
* certificate and include the chain of trust in order. This will be returned by
* {@link android.security.KeyChain#getCertificateChain}.
* @param alias The private key alias under which to install the certificate. If a certificate
* with that alias already exists, it will be overwritten.
* @param flags Flags to request that the calling app be granted access to the credentials
* and set the key to be user-selectable. See {@link #INSTALLKEY_SET_USER_SELECTABLE} and
* {@link #INSTALLKEY_REQUEST_CREDENTIALS_ACCESS}.
* @return {@code true} if the keys were installed, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner.
* @see android.security.KeyChain#getCertificateChain
* @see #setDelegatedScopes
* @see #DELEGATION_CERT_INSTALL
*/
public boolean installKeyPair(@Nullable ComponentName admin, @NonNull PrivateKey privKey,
@NonNull Certificate[] certs, @NonNull String alias, int flags) {
throwIfParentInstance("installKeyPair");
boolean requestAccess = (flags & INSTALLKEY_REQUEST_CREDENTIALS_ACCESS)
== INSTALLKEY_REQUEST_CREDENTIALS_ACCESS;
boolean isUserSelectable = (flags & INSTALLKEY_SET_USER_SELECTABLE)
== INSTALLKEY_SET_USER_SELECTABLE;
try {
final byte[] pemCert = Credentials.convertToPem(certs[0]);
byte[] pemChain = null;
if (certs.length > 1) {
pemChain = Credentials.convertToPem(Arrays.copyOfRange(certs, 1, certs.length));
}
final byte[] pkcs8Key = KeyFactory.getInstance(privKey.getAlgorithm())
.getKeySpec(privKey, PKCS8EncodedKeySpec.class).getEncoded();
return mService.installKeyPair(admin, mContext.getPackageName(), pkcs8Key, pemCert,
pemChain, alias, requestAccess, isUserSelectable);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
} catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
Log.w(TAG, "Failed to obtain private key material", e);
} catch (CertificateException | IOException e) {
Log.w(TAG, "Could not pem-encode certificate", e);
}
return false;
}
/**
* Called by a device or profile owner, or delegated certificate installer, to remove a
* certificate and private key pair installed under a given alias.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @param alias The private key alias under which the certificate is installed.
* @return {@code true} if the private key alias no longer exists, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner.
* @see #setDelegatedScopes
* @see #DELEGATION_CERT_INSTALL
*/
public boolean removeKeyPair(@Nullable ComponentName admin, @NonNull String alias) {
throwIfParentInstance("removeKeyPair");
try {
return mService.removeKeyPair(admin, mContext.getPackageName(), alias);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Called by a device or profile owner, or delegated certificate installer, to generate a
* new private/public key pair. If the device supports key generation via secure hardware,
* this method is useful for creating a key in KeyChain that never left the secure hardware.
* Access to the key is controlled the same way as in {@link #installKeyPair}.
*
* <p>Because this method might take several seconds to complete, it should only be called from
* a worker thread. This method returns {@code null} when called from the main thread.
*
* <p>Note: If the provided {@code alias} is of an existing alias, all former grants that apps
* have been given to access the key and certificates associated with this alias will be
* revoked.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @param algorithm The key generation algorithm, see {@link java.security.KeyPairGenerator}.
* @param keySpec Specification of the key to generate, see
* {@link java.security.KeyPairGenerator}.
* @param idAttestationFlags A bitmask of all the identifiers that should be included in the
* attestation record ({@code ID_TYPE_BASE_INFO}, {@code ID_TYPE_SERIAL},
* {@code ID_TYPE_IMEI} and {@code ID_TYPE_MEID}), or {@code 0} if no device
* identification is required in the attestation record.
* Device owner, profile owner and their delegated certificate installer can use
* {@link #ID_TYPE_BASE_INFO} to request inclusion of the general device information
* including manufacturer, model, brand, device and product in the attestation record.
* Only device owner and their delegated certificate installer can use
* {@link #ID_TYPE_SERIAL}, {@link #ID_TYPE_IMEI} and {@link #ID_TYPE_MEID} to request
* unique device identifiers to be attested.
* <p>
* If any of {@link #ID_TYPE_SERIAL}, {@link #ID_TYPE_IMEI} and {@link #ID_TYPE_MEID}
* is set, it is implicitly assumed that {@link #ID_TYPE_BASE_INFO} is also set.
* <p>
* If any flag is specified, then an attestation challenge must be included in the
* {@code keySpec}.
* @return A non-null {@code AttestedKeyPair} if the key generation succeeded, null otherwise.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner. If Device ID attestation is requested (using {@link #ID_TYPE_SERIAL},
* {@link #ID_TYPE_IMEI} or {@link #ID_TYPE_MEID}), the caller must be the Device Owner
* or the Certificate Installer delegate.
* @throws IllegalArgumentException if the alias in {@code keySpec} is empty, if the
* algorithm specification in {@code keySpec} is not {@code RSAKeyGenParameterSpec}
* or {@code ECGenParameterSpec}, or if Device ID attestation was requested but the
* {@code keySpec} does not contain an attestation challenge.
* @throws UnsupportedOperationException if Device ID attestation was requested but the
* underlying hardware does not support it.
* @throws StrongBoxUnavailableException if the use of StrongBox for key generation was
* specified in {@code keySpec} but the device does not have one.
* @see KeyGenParameterSpec.Builder#setAttestationChallenge(byte[])
*/
public AttestedKeyPair generateKeyPair(@Nullable ComponentName admin,
@NonNull String algorithm, @NonNull KeyGenParameterSpec keySpec,
@AttestationIdType int idAttestationFlags) {
throwIfParentInstance("generateKeyPair");
try {
final ParcelableKeyGenParameterSpec parcelableSpec =
new ParcelableKeyGenParameterSpec(keySpec);
KeymasterCertificateChain attestationChain = new KeymasterCertificateChain();
// Translate ID attestation flags to values used by AttestationUtils
final boolean success = mService.generateKeyPair(
admin, mContext.getPackageName(), algorithm, parcelableSpec,
idAttestationFlags, attestationChain);
if (!success) {
Log.e(TAG, "Error generating key via DevicePolicyManagerService.");
return null;
}
final String alias = keySpec.getKeystoreAlias();
final KeyPair keyPair = KeyChain.getKeyPair(mContext, alias);
Certificate[] outputChain = null;
try {
if (AttestationUtils.isChainValid(attestationChain)) {
outputChain = AttestationUtils.parseCertificateChain(attestationChain);
}
} catch (KeyAttestationException e) {
Log.e(TAG, "Error parsing attestation chain for alias " + alias, e);
mService.removeKeyPair(admin, mContext.getPackageName(), alias);
return null;
}
return new AttestedKeyPair(keyPair, outputChain);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
} catch (KeyChainException e) {
Log.w(TAG, "Failed to generate key", e);
} catch (InterruptedException e) {
Log.w(TAG, "Interrupted while generating key", e);
Thread.currentThread().interrupt();
} catch (ServiceSpecificException e) {
Log.w(TAG, String.format("Key Generation failure: %d", e.errorCode));
switch (e.errorCode) {
case KEY_GEN_STRONGBOX_UNAVAILABLE:
throw new StrongBoxUnavailableException("No StrongBox for key generation.");
default:
throw new RuntimeException(
String.format("Unknown error while generating key: %d", e.errorCode));
}
}
return null;
}
/**
* Returns {@code true} if the device supports attestation of device identifiers in addition
* to key attestation.
* @return {@code true} if Device ID attestation is supported.
*/
public boolean isDeviceIdAttestationSupported() {
PackageManager pm = mContext.getPackageManager();
return pm.hasSystemFeature(PackageManager.FEATURE_DEVICE_ID_ATTESTATION);
}
/**
* Called by a device or profile owner, or delegated certificate installer, to associate
* certificates with a key pair that was generated using {@link #generateKeyPair}, and
* set whether the key is available for the user to choose in the certificate selection
* prompt.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if calling from a delegated certificate installer.
* @param alias The private key alias under which to install the certificate. The {@code alias}
* should denote an existing private key. If a certificate with that alias already
* exists, it will be overwritten.
* @param certs The certificate chain to install. The chain should start with the leaf
* certificate and include the chain of trust in order. This will be returned by
* {@link android.security.KeyChain#getCertificateChain}.
* @param isUserSelectable {@code true} to indicate that a user can select this key via the
* certificate selection prompt, {@code false} to indicate that this key can only be
* granted access by implementing
* {@link android.app.admin.DeviceAdminReceiver#onChoosePrivateKeyAlias}.
* @return {@code true} if the provided {@code alias} exists and the certificates has been
* successfully associated with it, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not {@code null} and not a device or profile
* owner, or {@code admin} is null but the calling application is not a delegated
* certificate installer.
*/
public boolean setKeyPairCertificate(@Nullable ComponentName admin,
@NonNull String alias, @NonNull List<Certificate> certs, boolean isUserSelectable) {
throwIfParentInstance("setKeyPairCertificate");
try {
final byte[] pemCert = Credentials.convertToPem(certs.get(0));
byte[] pemChain = null;
if (certs.size() > 1) {
pemChain = Credentials.convertToPem(
certs.subList(1, certs.size()).toArray(new Certificate[0]));
}
return mService.setKeyPairCertificate(admin, mContext.getPackageName(), alias, pemCert,
pemChain, isUserSelectable);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
} catch (CertificateException | IOException e) {
Log.w(TAG, "Could not pem-encode certificate", e);
}
return false;
}
/**
* @return the alias of a given CA certificate in the certificate store, or {@code null} if it
* doesn't exist.
*/
private static String getCaCertAlias(byte[] certBuffer) throws CertificateException {
final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
final X509Certificate cert = (X509Certificate) certFactory.generateCertificate(
new ByteArrayInputStream(certBuffer));
return new TrustedCertificateStore().getCertificateAlias(cert);
}
/**
* Called by a profile owner or device owner to grant access to privileged certificate
* manipulation APIs to a third-party certificate installer app. Granted APIs include
* {@link #getInstalledCaCerts}, {@link #hasCaCertInstalled}, {@link #installCaCert},
* {@link #uninstallCaCert}, {@link #uninstallAllUserCaCerts} and {@link #installKeyPair}.
* <p>
* Delegated certificate installer is a per-user state. The delegated access is persistent until
* it is later cleared by calling this method with a null value or uninstallling the certificate
* installer.
* <p>
* <b>Note:</b>Starting from {@link android.os.Build.VERSION_CODES#N}, if the caller
* application's target SDK version is {@link android.os.Build.VERSION_CODES#N} or newer, the
* supplied certificate installer package must be installed when calling this API, otherwise an
* {@link IllegalArgumentException} will be thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param installerPackage The package name of the certificate installer which will be given
* access. If {@code null} is given the current package will be cleared.
* @throws SecurityException if {@code admin} is not a device or a profile owner.
*
* @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes}
* with the {@link #DELEGATION_CERT_INSTALL} scope instead.
*/
@Deprecated
public void setCertInstallerPackage(@NonNull ComponentName admin, @Nullable String
installerPackage) throws SecurityException {
throwIfParentInstance("setCertInstallerPackage");
if (mService != null) {
try {
mService.setCertInstallerPackage(admin, installerPackage);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile owner or device owner to retrieve the certificate installer for the user,
* or {@code null} if none is set. If there are multiple delegates this function will return one
* of them.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return The package name of the current delegated certificate installer, or {@code null} if
* none is set.
* @throws SecurityException if {@code admin} is not a device or a profile owner.
*
* @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages}
* with the {@link #DELEGATION_CERT_INSTALL} scope instead.
*/
@Deprecated
public @Nullable String getCertInstallerPackage(@NonNull ComponentName admin)
throws SecurityException {
throwIfParentInstance("getCertInstallerPackage");
if (mService != null) {
try {
return mService.getCertInstallerPackage(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by a profile owner or device owner to grant access to privileged APIs to another app.
* Granted APIs are determined by {@code scopes}, which is a list of the {@code DELEGATION_*}
* constants.
* <p>
* A broadcast with the {@link #ACTION_APPLICATION_DELEGATION_SCOPES_CHANGED} action will be
* sent to the {@code delegatePackage} with its new scopes in an {@code ArrayList<String>} extra
* under the {@link #EXTRA_DELEGATION_SCOPES} key. The broadcast is sent with the
* {@link Intent#FLAG_RECEIVER_REGISTERED_ONLY} flag.
* <p>
* Delegated scopes are a per-user state. The delegated access is persistent until it is later
* cleared by calling this method with an empty {@code scopes} list or uninstalling the
* {@code delegatePackage}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param delegatePackage The package name of the app which will be given access.
* @param scopes The groups of privileged APIs whose access should be granted to
* {@code delegatedPackage}.
* @throws SecurityException if {@code admin} is not a device or a profile owner.
*/
public void setDelegatedScopes(@NonNull ComponentName admin, @NonNull String delegatePackage,
@NonNull List<String> scopes) {
throwIfParentInstance("setDelegatedScopes");
if (mService != null) {
try {
mService.setDelegatedScopes(admin, delegatePackage, scopes);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile owner or device owner to retrieve a list of the scopes given to a
* delegate package. Other apps can use this method to retrieve their own delegated scopes by
* passing {@code null} for {@code admin} and their own package name as
* {@code delegatedPackage}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if the caller is {@code delegatedPackage}.
* @param delegatedPackage The package name of the app whose scopes should be retrieved.
* @return A list containing the scopes given to {@code delegatedPackage}.
* @throws SecurityException if {@code admin} is not a device or a profile owner.
*/
@NonNull
public List<String> getDelegatedScopes(@Nullable ComponentName admin,
@NonNull String delegatedPackage) {
throwIfParentInstance("getDelegatedScopes");
if (mService != null) {
try {
return mService.getDelegatedScopes(admin, delegatedPackage);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by a profile owner or device owner to retrieve a list of delegate packages that were
* granted a delegation scope.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param delegationScope The scope whose delegates should be retrieved.
* @return A list of package names of the current delegated packages for
{@code delegationScope}.
* @throws SecurityException if {@code admin} is not a device or a profile owner.
*/
@Nullable
public List<String> getDelegatePackages(@NonNull ComponentName admin,
@NonNull String delegationScope) {
throwIfParentInstance("getDelegatePackages");
if (mService != null) {
try {
return mService.getDelegatePackages(admin, delegationScope);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Service-specific error code used in implementation of {@code setAlwaysOnVpnPackage} methods.
* @hide
*/
public static final int ERROR_VPN_PACKAGE_NOT_FOUND = 1;
/**
* Called by a device or profile owner to configure an always-on VPN connection through a
* specific application for the current user. This connection is automatically granted and
* persisted after a reboot.
* <p> To support the always-on feature, an app must
* <ul>
* <li>declare a {@link android.net.VpnService} in its manifest, guarded by
* {@link android.Manifest.permission#BIND_VPN_SERVICE};</li>
* <li>target {@link android.os.Build.VERSION_CODES#N API 24} or above; and</li>
* <li><i>not</i> explicitly opt out of the feature through
* {@link android.net.VpnService#SERVICE_META_DATA_SUPPORTS_ALWAYS_ON}.</li>
* </ul>
* The call will fail if called with the package name of an unsupported VPN app.
* <p> Enabling lockdown via {@code lockdownEnabled} argument carries the risk that any failure
* of the VPN provider could break networking for all apps. This method clears any lockdown
* whitelist set by {@link #setAlwaysOnVpnPackage(ComponentName, String, boolean, Set)}.
*
* @param vpnPackage The package name for an installed VPN app on the device, or {@code null} to
* remove an existing always-on VPN configuration.
* @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
* {@code false} otherwise. This has no effect when clearing.
* @throws SecurityException if {@code admin} is not a device or a profile owner.
* @throws NameNotFoundException if {@code vpnPackage} is not installed.
* @throws UnsupportedOperationException if {@code vpnPackage} exists but does not support being
* set as always-on, or if always-on VPN is not available.
* @see #setAlwaysOnVpnPackage(ComponentName, String, boolean, Set)
*/
public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
boolean lockdownEnabled) throws NameNotFoundException {
setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled, Collections.emptySet());
}
/**
* A version of {@link #setAlwaysOnVpnPackage(ComponentName, String, boolean)} that allows the
* admin to specify a set of apps that should be able to access the network directly when VPN
* is not connected. When VPN connects these apps switch over to VPN if allowed to use that VPN.
* System apps can always bypass VPN.
* <p> Note that the system doesn't update the whitelist when packages are installed or
* uninstalled, the admin app must call this method to keep the list up to date.
* <p> When {@code lockdownEnabled} is false {@code lockdownWhitelist} is ignored . When
* {@code lockdownEnabled} is {@code true} and {@code lockdownWhitelist} is {@code null} or
* empty, only system apps can bypass VPN.
* <p> Setting always-on VPN package to {@code null} or using
* {@link #setAlwaysOnVpnPackage(ComponentName, String, boolean)} clears lockdown whitelist.
*
* @param vpnPackage package name for an installed VPN app on the device, or {@code null}
* to remove an existing always-on VPN configuration
* @param lockdownEnabled {@code true} to disallow networking when the VPN is not connected or
* {@code false} otherwise. This has no effect when clearing.
* @param lockdownWhitelist Packages that will be able to access the network directly when VPN
* is in lockdown mode but not connected. Has no effect when clearing.
* @throws SecurityException if {@code admin} is not a device or a profile
* owner.
* @throws NameNotFoundException if {@code vpnPackage} or one of
* {@code lockdownWhitelist} is not installed.
* @throws UnsupportedOperationException if {@code vpnPackage} exists but does
* not support being set as always-on, or if always-on VPN is not
* available.
*/
public void setAlwaysOnVpnPackage(@NonNull ComponentName admin, @Nullable String vpnPackage,
boolean lockdownEnabled, @Nullable Set<String> lockdownWhitelist)
throws NameNotFoundException {
throwIfParentInstance("setAlwaysOnVpnPackage");
if (mService != null) {
try {
mService.setAlwaysOnVpnPackage(admin, vpnPackage, lockdownEnabled,
lockdownWhitelist == null ? null : new ArrayList<>(lockdownWhitelist));
} catch (ServiceSpecificException e) {
switch (e.errorCode) {
case ERROR_VPN_PACKAGE_NOT_FOUND:
throw new NameNotFoundException(e.getMessage());
default:
throw new RuntimeException(
"Unknown error setting always-on VPN: " + e.errorCode, e);
}
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by device or profile owner to query whether current always-on VPN is configured in
* lockdown mode. Returns {@code false} when no always-on configuration is set.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
*
* @throws SecurityException if {@code admin} is not a device or a profile owner.
*
* @see #setAlwaysOnVpnPackage(ComponentName, String, boolean)
*/
public boolean isAlwaysOnVpnLockdownEnabled(@NonNull ComponentName admin) {
throwIfParentInstance("isAlwaysOnVpnLockdownEnabled");
if (mService != null) {
try {
return mService.isAlwaysOnVpnLockdownEnabled(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by device or profile owner to query the set of packages that are allowed to access
* the network directly when always-on VPN is in lockdown mode but not connected. Returns
* {@code null} when always-on VPN is not active or not in lockdown mode.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
*
* @throws SecurityException if {@code admin} is not a device or a profile owner.
*
* @see #setAlwaysOnVpnPackage(ComponentName, String, boolean, Set)
*/
public @Nullable Set<String> getAlwaysOnVpnLockdownWhitelist(@NonNull ComponentName admin) {
throwIfParentInstance("getAlwaysOnVpnLockdownWhitelist");
if (mService != null) {
try {
final List<String> whitelist =
mService.getAlwaysOnVpnLockdownWhitelist(admin);
return whitelist == null ? null : new HashSet<>(whitelist);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by a device or profile owner to read the name of the package administering an
* always-on VPN connection for the current user. If there is no such package, or the always-on
* VPN is provided by the system instead of by an application, {@code null} will be returned.
*
* @return Package name of VPN controller responsible for always-on VPN, or {@code null} if none
* is set.
* @throws SecurityException if {@code admin} is not a device or a profile owner.
*/
public @Nullable String getAlwaysOnVpnPackage(@NonNull ComponentName admin) {
throwIfParentInstance("getAlwaysOnVpnPackage");
if (mService != null) {
try {
return mService.getAlwaysOnVpnPackage(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by an application that is administering the device to disable all cameras on the
* device, for this user. After setting this, no applications running as this user will be able
* to access any cameras on the device.
* <p>
* If the caller is device owner, then the restriction will be applied to all users.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA} to be able to call this method; if it has
* not, a security exception will be thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param disabled Whether or not the camera should be disabled.
* @throws SecurityException if {@code admin} is not an active administrator or does not use
* {@link DeviceAdminInfo#USES_POLICY_DISABLE_CAMERA}.
*/
public void setCameraDisabled(@NonNull ComponentName admin, boolean disabled) {
throwIfParentInstance("setCameraDisabled");
if (mService != null) {
try {
mService.setCameraDisabled(admin, disabled);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Determine whether or not the device's cameras have been disabled for this user,
* either by the calling admin, if specified, or all admins.
* @param admin The name of the admin component to check, or {@code null} to check whether any admins
* have disabled the camera
*/
public boolean getCameraDisabled(@Nullable ComponentName admin) {
throwIfParentInstance("getCameraDisabled");
return getCameraDisabled(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage
public boolean getCameraDisabled(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getCameraDisabled(admin, userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by a device owner to request a bugreport.
* <p>
* If the device contains secondary users or profiles, they must be affiliated with the device.
* Otherwise a {@link SecurityException} will be thrown. See {@link #isAffiliatedUser}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return {@code true} if the bugreport collection started successfully, or {@code false} if it
* wasn't triggered because a previous bugreport operation is still active (either the
* bugreport is still running or waiting for the user to share or decline)
* @throws SecurityException if {@code admin} is not a device owner, or there is at least one
* profile or secondary user that is not affiliated with the device.
* @see #isAffiliatedUser
*/
public boolean requestBugreport(@NonNull ComponentName admin) {
throwIfParentInstance("requestBugreport");
if (mService != null) {
try {
return mService.requestBugreport(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Determine whether or not creating a guest user has been disabled for the device
*
* @hide
*/
public boolean getGuestUserDisabled(@Nullable ComponentName admin) {
// Currently guest users can always be created if multi-user is enabled
// TODO introduce a policy for guest user creation
return false;
}
/**
* Called by a device/profile owner to set whether the screen capture is disabled. Disabling
* screen capture also prevents the content from being shown on display devices that do not have
* a secure video output. See {@link android.view.Display#FLAG_SECURE} for more details about
* secure surfaces and secure displays.
* <p>
* The calling device admin must be a device or profile owner. If it is not, a security
* exception will be thrown.
* <p>
* From version {@link android.os.Build.VERSION_CODES#M} disabling screen capture also blocks
* assist requests for all activities of the relevant user.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param disabled Whether screen capture is disabled or not.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void setScreenCaptureDisabled(@NonNull ComponentName admin, boolean disabled) {
throwIfParentInstance("setScreenCaptureDisabled");
if (mService != null) {
try {
mService.setScreenCaptureDisabled(admin, disabled);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Determine whether or not screen capture has been disabled by the calling
* admin, if specified, or all admins.
* @param admin The name of the admin component to check, or {@code null} to check whether any admins
* have disabled screen capture.
*/
public boolean getScreenCaptureDisabled(@Nullable ComponentName admin) {
throwIfParentInstance("getScreenCaptureDisabled");
return getScreenCaptureDisabled(admin, myUserId());
}
/** @hide per-user version */
public boolean getScreenCaptureDisabled(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getScreenCaptureDisabled(admin, userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by a device owner, or alternatively a profile owner from Android 8.0 (API level 26) or
* higher, to set whether auto time is required. If auto time is required, no user will be able
* set the date and time and network date and time will be used.
* <p>
* Note: if auto time is required the user can still manually set the time zone.
* <p>
* The calling device admin must be a device owner, or alternatively a profile owner from
* Android 8.0 (API level 26) or higher. If it is not, a security exception will be thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param required Whether auto time is set required or not.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public void setAutoTimeRequired(@NonNull ComponentName admin, boolean required) {
throwIfParentInstance("setAutoTimeRequired");
if (mService != null) {
try {
mService.setAutoTimeRequired(admin, required);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @return true if auto time is required.
*/
public boolean getAutoTimeRequired() {
throwIfParentInstance("getAutoTimeRequired");
if (mService != null) {
try {
return mService.getAutoTimeRequired();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by a device owner to set whether all users created on the device should be ephemeral.
* <p>
* The system user is exempt from this policy - it is never ephemeral.
* <p>
* The calling device admin must be the device owner. If it is not, a security exception will be
* thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param forceEphemeralUsers If true, all the existing users will be deleted and all
* subsequently created users will be ephemeral.
* @throws SecurityException if {@code admin} is not a device owner.
* @hide
*/
public void setForceEphemeralUsers(
@NonNull ComponentName admin, boolean forceEphemeralUsers) {
throwIfParentInstance("setForceEphemeralUsers");
if (mService != null) {
try {
mService.setForceEphemeralUsers(admin, forceEphemeralUsers);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @return true if all users are created ephemeral.
* @throws SecurityException if {@code admin} is not a device owner.
* @hide
*/
public boolean getForceEphemeralUsers(@NonNull ComponentName admin) {
throwIfParentInstance("getForceEphemeralUsers");
if (mService != null) {
try {
return mService.getForceEphemeralUsers(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by an application that is administering the device to disable keyguard customizations,
* such as widgets. After setting this, keyguard features will be disabled according to the
* provided feature list.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
* if it has not, a security exception will be thrown.
* <p>
* Calling this from a managed profile before version {@link android.os.Build.VERSION_CODES#M}
* will throw a security exception. From version {@link android.os.Build.VERSION_CODES#M} the
* profile owner of a managed profile can set:
* <ul>
* <li>{@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which affects the parent user, but only if there
* is no separate challenge set on the managed profile.
* <li>{@link #KEYGUARD_DISABLE_FINGERPRINT}, {@link #KEYGUARD_DISABLE_FACE} or
* {@link #KEYGUARD_DISABLE_IRIS} which affects the managed profile challenge if
* there is one, or the parent user otherwise.
* <li>{@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS} which affects notifications generated
* by applications in the managed profile.
* </ul>
* {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, {@link #KEYGUARD_DISABLE_FINGERPRINT},
* {@link #KEYGUARD_DISABLE_FACE} and {@link #KEYGUARD_DISABLE_IRIS} can also be
* set on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set restrictions on the parent
* profile.
* <p>
* Requests to disable other features on a managed profile will be ignored.
* <p>
* The admin can check which features have been disabled by calling
* {@link #getKeyguardDisabledFeatures(ComponentName)}
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param which The disabled features flag which can be either
* {@link #KEYGUARD_DISABLE_FEATURES_NONE} (default),
* {@link #KEYGUARD_DISABLE_FEATURES_ALL}, or a combination of
* {@link #KEYGUARD_DISABLE_WIDGETS_ALL}, {@link #KEYGUARD_DISABLE_SECURE_CAMERA},
* {@link #KEYGUARD_DISABLE_SECURE_NOTIFICATIONS},
* {@link #KEYGUARD_DISABLE_TRUST_AGENTS},
* {@link #KEYGUARD_DISABLE_UNREDACTED_NOTIFICATIONS},
* {@link #KEYGUARD_DISABLE_FINGERPRINT},
* {@link #KEYGUARD_DISABLE_FACE},
* {@link #KEYGUARD_DISABLE_IRIS}.
* @throws SecurityException if {@code admin} is not an active administrator or does not user
* {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
*/
public void setKeyguardDisabledFeatures(@NonNull ComponentName admin, int which) {
if (mService != null) {
try {
mService.setKeyguardDisabledFeatures(admin, which, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Determine whether or not features have been disabled in keyguard either by the calling
* admin, if specified, or all admins that set restrictions on this user and its participating
* profiles. Restrictions on profiles that have a separate challenge are not taken into account.
*
* <p>This method can be called on the {@link DevicePolicyManager} instance
* returned by {@link #getParentProfileInstance(ComponentName)} in order to retrieve
* restrictions on the parent profile.
*
* @param admin The name of the admin component to check, or {@code null} to check whether any
* admins have disabled features in keyguard.
* @return bitfield of flags. See {@link #setKeyguardDisabledFeatures(ComponentName, int)}
* for a list.
*/
public int getKeyguardDisabledFeatures(@Nullable ComponentName admin) {
return getKeyguardDisabledFeatures(admin, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage
public int getKeyguardDisabledFeatures(@Nullable ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getKeyguardDisabledFeatures(admin, userHandle, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return KEYGUARD_DISABLE_FEATURES_NONE;
}
/**
* @hide
*/
@UnsupportedAppUsage
public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing,
int userHandle) {
if (mService != null) {
try {
mService.setActiveAdmin(policyReceiver, refreshing, userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @hide
*/
@UnsupportedAppUsage
public void setActiveAdmin(@NonNull ComponentName policyReceiver, boolean refreshing) {
setActiveAdmin(policyReceiver, refreshing, myUserId());
}
/**
* @hide
*/
public void getRemoveWarning(@Nullable ComponentName admin, RemoteCallback result) {
if (mService != null) {
try {
mService.getRemoveWarning(admin, result, myUserId());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @hide
*/
@UnsupportedAppUsage
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void setActivePasswordState(PasswordMetrics metrics, int userHandle) {
if (mService != null) {
try {
mService.setActivePasswordState(metrics, userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @hide
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void reportPasswordChanged(@UserIdInt int userId) {
if (mService != null) {
try {
mService.reportPasswordChanged(userId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @hide
*/
@UnsupportedAppUsage
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void reportFailedPasswordAttempt(int userHandle) {
if (mService != null) {
try {
mService.reportFailedPasswordAttempt(userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @hide
*/
@UnsupportedAppUsage
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void reportSuccessfulPasswordAttempt(int userHandle) {
if (mService != null) {
try {
mService.reportSuccessfulPasswordAttempt(userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @hide
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void reportFailedBiometricAttempt(int userHandle) {
if (mService != null) {
try {
mService.reportFailedBiometricAttempt(userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @hide
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void reportSuccessfulBiometricAttempt(int userHandle) {
if (mService != null) {
try {
mService.reportSuccessfulBiometricAttempt(userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Should be called when keyguard has been dismissed.
* @hide
*/
public void reportKeyguardDismissed(int userHandle) {
if (mService != null) {
try {
mService.reportKeyguardDismissed(userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Should be called when keyguard view has been shown to the user.
* @hide
*/
public void reportKeyguardSecured(int userHandle) {
if (mService != null) {
try {
mService.reportKeyguardSecured(userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* @hide
* Sets the given package as the device owner.
* Same as {@link #setDeviceOwner(ComponentName, String)} but without setting a device owner name.
* @param who the component name to be registered as device owner.
* @return whether the package was successfully registered as the device owner.
* @throws IllegalArgumentException if the package name is null or invalid
* @throws IllegalStateException If the preconditions mentioned are not met.
*/
public boolean setDeviceOwner(ComponentName who) {
return setDeviceOwner(who, null);
}
/**
* @hide
*/
public boolean setDeviceOwner(ComponentName who, int userId) {
return setDeviceOwner(who, null, userId);
}
/**
* @hide
*/
public boolean setDeviceOwner(ComponentName who, String ownerName) {
return setDeviceOwner(who, ownerName, UserHandle.USER_SYSTEM);
}
/**
* @hide
* Sets the given package as the device owner. The package must already be installed. There
* must not already be a device owner.
* Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
* this method.
* Calling this after the setup phase of the primary user has completed is allowed only if
* the caller is the shell uid, and there are no additional users and no accounts.
* @param who the component name to be registered as device owner.
* @param ownerName the human readable name of the institution that owns this device.
* @param userId ID of the user on which the device owner runs.
* @return whether the package was successfully registered as the device owner.
* @throws IllegalArgumentException if the package name is null or invalid
* @throws IllegalStateException If the preconditions mentioned are not met.
*/
public boolean setDeviceOwner(ComponentName who, String ownerName, int userId)
throws IllegalArgumentException, IllegalStateException {
if (mService != null) {
try {
return mService.setDeviceOwner(who, ownerName, userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* Used to determine if a particular package has been registered as a Device Owner app.
* A device owner app is a special device admin that cannot be deactivated by the user, once
* activated as a device admin. It also cannot be uninstalled. To check whether a particular
* package is currently registered as the device owner app, pass in the package name from
* {@link Context#getPackageName()} to this method.<p/>This is useful for device
* admin apps that want to check whether they are also registered as the device owner app. The
* exact mechanism by which a device admin app is registered as a device owner app is defined by
* the setup process.
* @param packageName the package name of the app, to compare with the registered device owner
* app, if any.
* @return whether or not the package is registered as the device owner app.
*/
public boolean isDeviceOwnerApp(String packageName) {
throwIfParentInstance("isDeviceOwnerApp");
return isDeviceOwnerAppOnCallingUser(packageName);
}
/**
* @return true if a package is registered as device owner, only when it's running on the
* calling user.
*
* <p>Same as {@link #isDeviceOwnerApp}, but bundled code should use it for clarity.
* @hide
*/
public boolean isDeviceOwnerAppOnCallingUser(String packageName) {
return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ true);
}
/**
* @return true if a package is registered as device owner, even if it's running on a different
* user.
*
* <p>Requires the MANAGE_USERS permission.
*
* @hide
*/
public boolean isDeviceOwnerAppOnAnyUser(String packageName) {
return isDeviceOwnerAppOnAnyUserInner(packageName, /* callingUserOnly =*/ false);
}
/**
* @return device owner component name, only when it's running on the calling user.
*
* @hide
*/
public ComponentName getDeviceOwnerComponentOnCallingUser() {
return getDeviceOwnerComponentInner(/* callingUserOnly =*/ true);
}
/**
* @return device owner component name, even if it's running on a different user.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public ComponentName getDeviceOwnerComponentOnAnyUser() {
return getDeviceOwnerComponentInner(/* callingUserOnly =*/ false);
}
private boolean isDeviceOwnerAppOnAnyUserInner(String packageName, boolean callingUserOnly) {
if (packageName == null) {
return false;
}
final ComponentName deviceOwner = getDeviceOwnerComponentInner(callingUserOnly);
if (deviceOwner == null) {
return false;
}
return packageName.equals(deviceOwner.getPackageName());
}
private ComponentName getDeviceOwnerComponentInner(boolean callingUserOnly) {
if (mService != null) {
try {
return mService.getDeviceOwnerComponent(callingUserOnly);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return null;
}
/**
* @return Handle of the user who runs device owner, or {@code null} if there's no device owner.
*
* @hide
*/
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@SystemApi
public @Nullable UserHandle getDeviceOwnerUser() {
if (mService != null) {
try {
int userId = mService.getDeviceOwnerUserId();
if (userId != UserHandle.USER_NULL) {
return UserHandle.of(userId);
}
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return null;
}
/**
* @hide
*/
public int getDeviceOwnerUserId() {
if (mService != null) {
try {
return mService.getDeviceOwnerUserId();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return UserHandle.USER_NULL;
}
/**
* Clears the current device owner. The caller must be the device owner. This function should be
* used cautiously as once it is called it cannot be undone. The device owner can only be set as
* a part of device setup, before it completes.
* <p>
* While some policies previously set by the device owner will be cleared by this method, it is
* a best-effort process and some other policies will still remain in place after the device
* owner is cleared.
*
* @param packageName The package name of the device owner.
* @throws SecurityException if the caller is not in {@code packageName} or {@code packageName}
* does not own the current device owner component.
*
* @deprecated This method is expected to be used for testing purposes only. The device owner
* will lose control of the device and its data after calling it. In order to protect any
* sensitive data that remains on the device, it is advised that the device owner factory resets
* the device instead of calling this method. See {@link #wipeData(int)}.
*/
@Deprecated
public void clearDeviceOwnerApp(String packageName) {
throwIfParentInstance("clearDeviceOwnerApp");
if (mService != null) {
try {
mService.clearDeviceOwner(packageName);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* Returns the device owner package name, only if it's running on the calling user.
*
* <p>Bundled components should use {@code getDeviceOwnerComponentOnCallingUser()} for clarity.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public @Nullable String getDeviceOwner() {
throwIfParentInstance("getDeviceOwner");
final ComponentName name = getDeviceOwnerComponentOnCallingUser();
return name != null ? name.getPackageName() : null;
}
/**
* Called by the system to find out whether the device is managed by a Device Owner.
*
* @return whether the device is managed by a Device Owner.
* @throws SecurityException if the caller is not the device owner, does not hold the
* MANAGE_USERS permission and is not the system.
*
* @hide
*/
@SystemApi
@TestApi
@SuppressLint("Doclava125")
public boolean isDeviceManaged() {
try {
return mService.hasDeviceOwner();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the device owner name. Note this method *will* return the device owner
* name when it's running on a different user.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public String getDeviceOwnerNameOnAnyUser() {
throwIfParentInstance("getDeviceOwnerNameOnAnyUser");
if (mService != null) {
try {
return mService.getDeviceOwnerName();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return null;
}
/**
* @hide
* @deprecated Do not use
* @removed
*/
@Deprecated
@SystemApi
@SuppressLint("Doclava125")
public @Nullable String getDeviceInitializerApp() {
return null;
}
/**
* @hide
* @deprecated Do not use
* @removed
*/
@Deprecated
@SystemApi
@SuppressLint("Doclava125")
public @Nullable ComponentName getDeviceInitializerComponent() {
return null;
}
/**
* @hide
* @deprecated Use #ACTION_SET_PROFILE_OWNER
* Sets the given component as an active admin and registers the package as the profile
* owner for this user. The package must already be installed and there shouldn't be
* an existing profile owner registered for this user. Also, this method must be called
* before the user setup has been completed.
* <p>
* This method can only be called by system apps that hold MANAGE_USERS permission and
* MANAGE_DEVICE_ADMINS permission.
* @param admin The component to register as an active admin and profile owner.
* @param ownerName The user-visible name of the entity that is managing this user.
* @return whether the admin was successfully registered as the profile owner.
* @throws IllegalArgumentException if packageName is null, the package isn't installed, or
* the user has already been set up.
*/
@Deprecated
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_DEVICE_ADMINS)
public boolean setActiveProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName)
throws IllegalArgumentException {
throwIfParentInstance("setActiveProfileOwner");
if (mService != null) {
try {
final int myUserId = myUserId();
mService.setActiveAdmin(admin, false, myUserId);
return mService.setProfileOwner(admin, ownerName, myUserId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* Clears the active profile owner. The caller must be the profile owner of this user, otherwise
* a SecurityException will be thrown. This method is not available to managed profile owners.
* <p>
* While some policies previously set by the profile owner will be cleared by this method, it is
* a best-effort process and some other policies will still remain in place after the profile
* owner is cleared.
*
* @param admin The component to remove as the profile owner.
* @throws SecurityException if {@code admin} is not an active profile owner, or the method is
* being called from a managed profile.
*
* @deprecated This method is expected to be used for testing purposes only. The profile owner
* will lose control of the user and its data after calling it. In order to protect any
* sensitive data that remains on this user, it is advised that the profile owner deletes it
* instead of calling this method. See {@link #wipeData(int)}.
*/
@Deprecated
public void clearProfileOwner(@NonNull ComponentName admin) {
throwIfParentInstance("clearProfileOwner");
if (mService != null) {
try {
mService.clearProfileOwner(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* @hide
* Checks whether the user was already setup.
*/
public boolean hasUserSetupCompleted() {
if (mService != null) {
try {
return mService.hasUserSetupCompleted();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return true;
}
/**
* @hide
* Sets the given component as the profile owner of the given user profile. The package must
* already be installed. There must not already be a profile owner for this user.
* Only apps with the MANAGE_PROFILE_AND_DEVICE_OWNERS permission and the shell uid can call
* this method.
* Calling this after the setup phase of the specified user has completed is allowed only if:
* - the caller is SYSTEM_UID.
* - or the caller is the shell uid, and there are no accounts on the specified user.
* @param admin the component name to be registered as profile owner.
* @param ownerName the human readable name of the organisation associated with this DPM.
* @param userHandle the userId to set the profile owner for.
* @return whether the component was successfully registered as the profile owner.
* @throws IllegalArgumentException if admin is null, the package isn't installed, or the
* preconditions mentioned are not met.
*/
public boolean setProfileOwner(@NonNull ComponentName admin, @Deprecated String ownerName,
int userHandle) throws IllegalArgumentException {
if (mService != null) {
try {
if (ownerName == null) {
ownerName = "";
}
return mService.setProfileOwner(admin, ownerName, userHandle);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* Sets the device owner information to be shown on the lock screen.
* <p>
* If the device owner information is {@code null} or empty then the device owner info is
* cleared and the user owner info is shown on the lock screen if it is set.
* <p>
* If the device owner information contains only whitespaces then the message on the lock screen
* will be blank and the user will not be allowed to change it.
* <p>
* If the device owner information needs to be localized, it is the responsibility of the
* {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
* and set a new version of this string accordingly.
*
* @param admin The name of the admin component to check.
* @param info Device owner information which will be displayed instead of the user owner info.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public void setDeviceOwnerLockScreenInfo(@NonNull ComponentName admin, CharSequence info) {
throwIfParentInstance("setDeviceOwnerLockScreenInfo");
if (mService != null) {
try {
mService.setDeviceOwnerLockScreenInfo(admin, info);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* @return The device owner information. If it is not set returns {@code null}.
*/
public CharSequence getDeviceOwnerLockScreenInfo() {
throwIfParentInstance("getDeviceOwnerLockScreenInfo");
if (mService != null) {
try {
return mService.getDeviceOwnerLockScreenInfo();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by device or profile owners to suspend packages for this user. This function can be
* called by a device owner, profile owner, or by a delegate given the
* {@link #DELEGATION_PACKAGE_ACCESS} scope via {@link #setDelegatedScopes}.
* <p>
* A suspended package will not be able to start activities. Its notifications will be hidden,
* it will not show up in recents, will not be able to show toasts or dialogs or ring the
* device.
* <p>
* The package must already be installed. If the package is uninstalled while suspended the
* package will no longer be suspended. The admin can block this by using
* {@link #setUninstallBlocked}.
*
* @param admin The name of the admin component to check, or {@code null} if the caller is a
* package access delegate.
* @param packageNames The package names to suspend or unsuspend.
* @param suspended If set to {@code true} than the packages will be suspended, if set to
* {@code false} the packages will be unsuspended.
* @return an array of package names for which the suspended status is not set as requested in
* this method.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setDelegatedScopes
* @see #DELEGATION_PACKAGE_ACCESS
*/
public @NonNull String[] setPackagesSuspended(@NonNull ComponentName admin,
@NonNull String[] packageNames, boolean suspended) {
throwIfParentInstance("setPackagesSuspended");
if (mService != null) {
try {
return mService.setPackagesSuspended(admin, mContext.getPackageName(), packageNames,
suspended);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return packageNames;
}
/**
* Determine if a package is suspended. This function can be called by a device owner, profile
* owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
* {@link #setDelegatedScopes}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if the caller is a package access delegate.
* @param packageName The name of the package to retrieve the suspended status of.
* @return {@code true} if the package is suspended or {@code false} if the package is not
* suspended, could not be found or an error occurred.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @throws NameNotFoundException if the package could not be found.
* @see #setDelegatedScopes
* @see #DELEGATION_PACKAGE_ACCESS
*/
public boolean isPackageSuspended(@NonNull ComponentName admin, String packageName)
throws NameNotFoundException {
throwIfParentInstance("isPackageSuspended");
if (mService != null) {
try {
return mService.isPackageSuspended(admin, mContext.getPackageName(), packageName);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
} catch (IllegalArgumentException ex) {
throw new NameNotFoundException(packageName);
}
}
return false;
}
/**
* Sets the enabled state of the profile. A profile should be enabled only once it is ready to
* be used. Only the profile owner can call this.
*
* @see #isProfileOwnerApp
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public void setProfileEnabled(@NonNull ComponentName admin) {
throwIfParentInstance("setProfileEnabled");
if (mService != null) {
try {
mService.setProfileEnabled(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Sets the name of the profile. In the device owner case it sets the name of the user which it
* is called from. Only a profile owner or device owner can call this. If this is never called
* by the profile or device owner, the name will be set to default values.
*
* @see #isProfileOwnerApp
* @see #isDeviceOwnerApp
* @param admin Which {@link DeviceAdminReceiver} this request is associate with.
* @param profileName The name of the profile.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void setProfileName(@NonNull ComponentName admin, String profileName) {
throwIfParentInstance("setProfileName");
if (mService != null) {
try {
mService.setProfileName(admin, profileName);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Used to determine if a particular package is registered as the profile owner for the
* user. A profile owner is a special device admin that has additional privileges
* within the profile.
*
* @param packageName The package name of the app to compare with the registered profile owner.
* @return Whether or not the package is registered as the profile owner.
*/
public boolean isProfileOwnerApp(String packageName) {
throwIfParentInstance("isProfileOwnerApp");
if (mService != null) {
try {
ComponentName profileOwner = mService.getProfileOwner(myUserId());
return profileOwner != null
&& profileOwner.getPackageName().equals(packageName);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* @hide
* @return the packageName of the owner of the given user profile or {@code null} if no profile
* owner has been set for that user.
* @throws IllegalArgumentException if the userId is invalid.
*/
@SystemApi
public @Nullable ComponentName getProfileOwner() throws IllegalArgumentException {
throwIfParentInstance("getProfileOwner");
return getProfileOwnerAsUser(mContext.getUserId());
}
/**
* @see #getProfileOwner()
* @hide
*/
@RequiresPermission(value = android.Manifest.permission.INTERACT_ACROSS_USERS,
conditional = true)
public @Nullable ComponentName getProfileOwnerAsUser(@NonNull UserHandle user) {
if (mService != null) {
try {
return mService.getProfileOwnerAsUser(user.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return null;
}
/**
* @hide
*/
@UnsupportedAppUsage
public @Nullable ComponentName getProfileOwnerAsUser(final int userId) {
if (mService != null) {
try {
return mService.getProfileOwnerAsUser(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return null;
}
/**
* @hide
* @return the human readable name of the organisation associated with this DPM or {@code null}
* if one is not set.
* @throws IllegalArgumentException if the userId is invalid.
*/
public @Nullable String getProfileOwnerName() throws IllegalArgumentException {
if (mService != null) {
try {
return mService.getProfileOwnerName(mContext.getUserId());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return null;
}
/**
* @hide
* @param userId The user for whom to fetch the profile owner name, if any.
* @return the human readable name of the organisation associated with this profile owner or
* null if one is not set.
* @throws IllegalArgumentException if the userId is invalid.
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public @Nullable String getProfileOwnerNameAsUser(int userId) throws IllegalArgumentException {
throwIfParentInstance("getProfileOwnerNameAsUser");
if (mService != null) {
try {
return mService.getProfileOwnerName(userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return null;
}
/**
* Returns whether the specified package can read the device identifiers.
*
* @param packageName The package name of the app to check for device identifier access.
* @param pid The process id of the package to be checked.
* @param uid The uid of the package to be checked.
* @return whether the package can read the device identifiers.
*
* @hide
*/
public boolean checkDeviceIdentifierAccess(String packageName, int pid, int uid) {
throwIfParentInstance("checkDeviceIdentifierAccess");
if (packageName == null) {
return false;
}
if (mService != null) {
try {
return mService.checkDeviceIdentifierAccess(packageName, pid, uid);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by a profile owner or device owner to set a default activity that the system selects
* to handle intents that match the given {@link IntentFilter}. This activity will remain the
* default intent handler even if the set of potential event handlers for the intent filter
* changes and if the intent preferences are reset.
* <p>
* Note that the caller should still declare the activity in the manifest, the API just sets
* the activity to be the default one to handle the given intent filter.
* <p>
* The default disambiguation mechanism takes over if the activity is not installed (anymore).
* When the activity is (re)installed, it is automatically reset as default intent handler for
* the filter.
* <p>
* The calling device admin must be a profile owner or device owner. If it is not, a security
* exception will be thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param filter The IntentFilter for which a default handler is added.
* @param activity The Activity that is added as default intent handler.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void addPersistentPreferredActivity(@NonNull ComponentName admin, IntentFilter filter,
@NonNull ComponentName activity) {
throwIfParentInstance("addPersistentPreferredActivity");
if (mService != null) {
try {
mService.addPersistentPreferredActivity(admin, filter, activity);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile owner or device owner to remove all persistent intent handler preferences
* associated with the given package that were set by {@link #addPersistentPreferredActivity}.
* <p>
* The calling device admin must be a profile owner. If it is not, a security exception will be
* thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName The name of the package for which preferences are removed.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void clearPackagePersistentPreferredActivities(@NonNull ComponentName admin,
String packageName) {
throwIfParentInstance("clearPackagePersistentPreferredActivities");
if (mService != null) {
try {
mService.clearPackagePersistentPreferredActivities(admin, packageName);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a device owner to set the default SMS application.
* <p>
* The calling device admin must be a device owner. If it is not, a security exception will be
* thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName The name of the package to set as the default SMS application.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public void setDefaultSmsApplication(@NonNull ComponentName admin,
@NonNull String packageName) {
throwIfParentInstance("setDefaultSmsApplication");
if (mService != null) {
try {
mService.setDefaultSmsApplication(admin, packageName);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile owner or device owner to grant permission to a package to manage
* application restrictions for the calling user via {@link #setApplicationRestrictions} and
* {@link #getApplicationRestrictions}.
* <p>
* This permission is persistent until it is later cleared by calling this method with a
* {@code null} value or uninstalling the managing package.
* <p>
* The supplied application restriction managing package must be installed when calling this
* API, otherwise an {@link NameNotFoundException} will be thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName The package name which will be given access to application restrictions
* APIs. If {@code null} is given the current package will be cleared.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @throws NameNotFoundException if {@code packageName} is not found
*
* @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #setDelegatedScopes}
* with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead.
*/
@Deprecated
public void setApplicationRestrictionsManagingPackage(@NonNull ComponentName admin,
@Nullable String packageName) throws NameNotFoundException {
throwIfParentInstance("setApplicationRestrictionsManagingPackage");
if (mService != null) {
try {
if (!mService.setApplicationRestrictionsManagingPackage(admin, packageName)) {
throw new NameNotFoundException(packageName);
}
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile owner or device owner to retrieve the application restrictions managing
* package for the current user, or {@code null} if none is set. If there are multiple
* delegates this function will return one of them.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return The package name allowed to manage application restrictions on the current user, or
* {@code null} if none is set.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*
* @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatePackages}
* with the {@link #DELEGATION_APP_RESTRICTIONS} scope instead.
*/
@Deprecated
@Nullable
public String getApplicationRestrictionsManagingPackage(
@NonNull ComponentName admin) {
throwIfParentInstance("getApplicationRestrictionsManagingPackage");
if (mService != null) {
try {
return mService.getApplicationRestrictionsManagingPackage(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by any application to find out whether it has been granted permission via
* {@link #setApplicationRestrictionsManagingPackage} to manage application restrictions
* for the calling user.
*
* <p>This is done by comparing the calling Linux uid with the uid of the package specified by
* that method.
*
* @deprecated From {@link android.os.Build.VERSION_CODES#O}. Use {@link #getDelegatedScopes}
* instead.
*/
@Deprecated
public boolean isCallerApplicationRestrictionsManagingPackage() {
throwIfParentInstance("isCallerApplicationRestrictionsManagingPackage");
if (mService != null) {
try {
return mService.isCallerApplicationRestrictionsManagingPackage(
mContext.getPackageName());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Sets the application restrictions for a given target application running in the calling user.
* <p>
* The caller must be a profile or device owner on that user, or the package allowed to manage
* application restrictions via {@link #setDelegatedScopes} with the
* {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown.
* <p>
* The provided {@link Bundle} consists of key-value pairs, where the types of values may be:
* <ul>
* <li>{@code boolean}
* <li>{@code int}
* <li>{@code String} or {@code String[]}
* <li>From {@link android.os.Build.VERSION_CODES#M}, {@code Bundle} or {@code Bundle[]}
* </ul>
* <p>
* If the restrictions are not available yet, but may be applied in the near future, the caller
* can notify the target application of that by adding
* {@link UserManager#KEY_RESTRICTIONS_PENDING} to the settings parameter.
* <p>
* The application restrictions are only made visible to the target application via
* {@link UserManager#getApplicationRestrictions(String)}, in addition to the profile or device
* owner, and the application restrictions managing package via
* {@link #getApplicationRestrictions}.
*
* <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if called by the application restrictions managing package.
* @param packageName The name of the package to update restricted settings for.
* @param settings A {@link Bundle} to be parsed by the receiving application, conveying a new
* set of active restrictions.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setDelegatedScopes
* @see #DELEGATION_APP_RESTRICTIONS
* @see UserManager#KEY_RESTRICTIONS_PENDING
*/
@WorkerThread
public void setApplicationRestrictions(@Nullable ComponentName admin, String packageName,
Bundle settings) {
throwIfParentInstance("setApplicationRestrictions");
if (mService != null) {
try {
mService.setApplicationRestrictions(admin, mContext.getPackageName(), packageName,
settings);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Sets a list of configuration features to enable for a trust agent component. This is meant to
* be used in conjunction with {@link #KEYGUARD_DISABLE_TRUST_AGENTS}, which disables all trust
* agents but those enabled by this function call. If flag
* {@link #KEYGUARD_DISABLE_TRUST_AGENTS} is not set, then this call has no effect.
* <p>
* For any specific trust agent, whether it is disabled or not depends on the aggregated state
* of each admin's {@link #KEYGUARD_DISABLE_TRUST_AGENTS} setting and its trust agent
* configuration as set by this function call. In particular: if any admin sets
* {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and does not additionally set any
* trust agent configuration, the trust agent is disabled completely. Otherwise, the trust agent
* will receive the list of configurations from all admins who set
* {@link #KEYGUARD_DISABLE_TRUST_AGENTS} and aggregate the configurations to determine its
* behavior. The exact meaning of aggregation is trust-agent-specific.
* <p>
* The calling device admin must have requested
* {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES} to be able to call this method;
* if not, a security exception will be thrown.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to set the configuration for
* the parent profile.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, calling
* this method has no effect - no trust agent configuration will be set.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param target Component name of the agent to be configured.
* @param configuration Trust-agent-specific feature configuration bundle. Please consult
* documentation of the specific trust agent to determine the interpretation of this
* bundle.
* @throws SecurityException if {@code admin} is not an active administrator or does not use
* {@link DeviceAdminInfo#USES_POLICY_DISABLE_KEYGUARD_FEATURES}
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public void setTrustAgentConfiguration(@NonNull ComponentName admin,
@NonNull ComponentName target, PersistableBundle configuration) {
if (mService != null) {
try {
mService.setTrustAgentConfiguration(admin, target, configuration, mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Gets configuration for the given trust agent based on aggregating all calls to
* {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)} for
* all device admins.
* <p>
* This method can be called on the {@link DevicePolicyManager} instance returned by
* {@link #getParentProfileInstance(ComponentName)} in order to retrieve the configuration set
* on the parent profile.
* <p>
* On devices not supporting {@link PackageManager#FEATURE_SECURE_LOCK_SCREEN} feature, null is
* always returned.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with. If null,
* this function returns a list of configurations for all admins that declare
* {@link #KEYGUARD_DISABLE_TRUST_AGENTS}. If any admin declares
* {@link #KEYGUARD_DISABLE_TRUST_AGENTS} but doesn't call
* {@link #setTrustAgentConfiguration(ComponentName, ComponentName, PersistableBundle)}
* for this {@param agent} or calls it with a null configuration, null is returned.
* @param agent Which component to get enabled features for.
* @return configuration for the given trust agent.
*/
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
@Nullable ComponentName admin, @NonNull ComponentName agent) {
return getTrustAgentConfiguration(admin, agent, myUserId());
}
/** @hide per-user version */
@UnsupportedAppUsage
@RequiresFeature(PackageManager.FEATURE_SECURE_LOCK_SCREEN)
public @Nullable List<PersistableBundle> getTrustAgentConfiguration(
@Nullable ComponentName admin, @NonNull ComponentName agent, int userHandle) {
if (mService != null) {
try {
return mService.getTrustAgentConfiguration(admin, agent, userHandle,
mParentInstance);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return new ArrayList<PersistableBundle>(); // empty list
}
/**
* Called by a profile owner of a managed profile to set whether caller-Id information from the
* managed profile will be shown in the parent profile, for incoming calls.
* <p>
* The calling device admin must be a profile owner. If it is not, a security exception will be
* thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param disabled If true caller-Id information in the managed profile is not displayed.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public void setCrossProfileCallerIdDisabled(@NonNull ComponentName admin, boolean disabled) {
throwIfParentInstance("setCrossProfileCallerIdDisabled");
if (mService != null) {
try {
mService.setCrossProfileCallerIdDisabled(admin, disabled);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile owner of a managed profile to determine whether or not caller-Id
* information has been disabled.
* <p>
* The calling device admin must be a profile owner. If it is not, a security exception will be
* thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public boolean getCrossProfileCallerIdDisabled(@NonNull ComponentName admin) {
throwIfParentInstance("getCrossProfileCallerIdDisabled");
if (mService != null) {
try {
return mService.getCrossProfileCallerIdDisabled(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Determine whether or not caller-Id information has been disabled.
*
* @param userHandle The user for whom to check the caller-id permission
* @hide
*/
public boolean getCrossProfileCallerIdDisabled(UserHandle userHandle) {
if (mService != null) {
try {
return mService.getCrossProfileCallerIdDisabledForUser(userHandle.getIdentifier());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by a profile owner of a managed profile to set whether contacts search from the
* managed profile will be shown in the parent profile, for incoming calls.
* <p>
* The calling device admin must be a profile owner. If it is not, a security exception will be
* thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param disabled If true contacts search in the managed profile is not displayed.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public void setCrossProfileContactsSearchDisabled(@NonNull ComponentName admin,
boolean disabled) {
throwIfParentInstance("setCrossProfileContactsSearchDisabled");
if (mService != null) {
try {
mService.setCrossProfileContactsSearchDisabled(admin, disabled);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile owner of a managed profile to determine whether or not contacts search
* has been disabled.
* <p>
* The calling device admin must be a profile owner. If it is not, a security exception will be
* thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public boolean getCrossProfileContactsSearchDisabled(@NonNull ComponentName admin) {
throwIfParentInstance("getCrossProfileContactsSearchDisabled");
if (mService != null) {
try {
return mService.getCrossProfileContactsSearchDisabled(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Determine whether or not contacts search has been disabled.
*
* @param userHandle The user for whom to check the contacts search permission
* @hide
*/
public boolean getCrossProfileContactsSearchDisabled(@NonNull UserHandle userHandle) {
if (mService != null) {
try {
return mService
.getCrossProfileContactsSearchDisabledForUser(userHandle.getIdentifier());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Start Quick Contact on the managed profile for the user, if the policy allows.
*
* @hide
*/
public void startManagedQuickContact(String actualLookupKey, long actualContactId,
boolean isContactIdIgnored, long directoryId, Intent originalIntent) {
if (mService != null) {
try {
mService.startManagedQuickContact(actualLookupKey, actualContactId,
isContactIdIgnored, directoryId, originalIntent);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Start Quick Contact on the managed profile for the user, if the policy allows.
* @hide
*/
public void startManagedQuickContact(String actualLookupKey, long actualContactId,
Intent originalIntent) {
startManagedQuickContact(actualLookupKey, actualContactId, false, Directory.DEFAULT,
originalIntent);
}
/**
* Called by a profile owner of a managed profile to set whether bluetooth devices can access
* enterprise contacts.
* <p>
* The calling device admin must be a profile owner. If it is not, a security exception will be
* thrown.
* <p>
* This API works on managed profile only.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param disabled If true, bluetooth devices cannot access enterprise contacts.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public void setBluetoothContactSharingDisabled(@NonNull ComponentName admin, boolean disabled) {
throwIfParentInstance("setBluetoothContactSharingDisabled");
if (mService != null) {
try {
mService.setBluetoothContactSharingDisabled(admin, disabled);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile owner of a managed profile to determine whether or not Bluetooth devices
* cannot access enterprise contacts.
* <p>
* The calling device admin must be a profile owner. If it is not, a security exception will be
* thrown.
* <p>
* This API works on managed profile only.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public boolean getBluetoothContactSharingDisabled(@NonNull ComponentName admin) {
throwIfParentInstance("getBluetoothContactSharingDisabled");
if (mService != null) {
try {
return mService.getBluetoothContactSharingDisabled(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return true;
}
/**
* Determine whether or not Bluetooth devices cannot access contacts.
* <p>
* This API works on managed profile UserHandle only.
*
* @param userHandle The user for whom to check the caller-id permission
* @hide
*/
public boolean getBluetoothContactSharingDisabled(UserHandle userHandle) {
if (mService != null) {
try {
return mService.getBluetoothContactSharingDisabledForUser(userHandle
.getIdentifier());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return true;
}
/**
* Called by the profile owner of a managed profile so that some intents sent in the managed
* profile can also be resolved in the parent, or vice versa. Only activity intents are
* supported.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param filter The {@link IntentFilter} the intent has to match to be also resolved in the
* other profile
* @param flags {@link DevicePolicyManager#FLAG_MANAGED_CAN_ACCESS_PARENT} and
* {@link DevicePolicyManager#FLAG_PARENT_CAN_ACCESS_MANAGED} are supported.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void addCrossProfileIntentFilter(@NonNull ComponentName admin, IntentFilter filter, int flags) {
throwIfParentInstance("addCrossProfileIntentFilter");
if (mService != null) {
try {
mService.addCrossProfileIntentFilter(admin, filter, flags);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile owner of a managed profile to remove the cross-profile intent filters
* that go from the managed profile to the parent, or from the parent to the managed profile.
* Only removes those that have been set by the profile owner.
* <p>
* <em>Note</em>: A list of default cross profile intent filters are set up by the system when
* the profile is created, some of them ensure the proper functioning of the profile, while
* others enable sharing of data from the parent to the managed profile for user convenience.
* These default intent filters are not cleared when this API is called. If the default cross
* profile data sharing is not desired, they can be disabled with
* {@link UserManager#DISALLOW_SHARE_INTO_MANAGED_PROFILE}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public void clearCrossProfileIntentFilters(@NonNull ComponentName admin) {
throwIfParentInstance("clearCrossProfileIntentFilters");
if (mService != null) {
try {
mService.clearCrossProfileIntentFilters(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile or device owner to set the permitted
* {@link android.accessibilityservice.AccessibilityService}. When set by
* a device owner or profile owner the restriction applies to all profiles of the user the
* device owner or profile owner is an admin for. By default, the user can use any accessibility
* service. When zero or more packages have been added, accessibility services that are not in
* the list and not part of the system can not be enabled by the user.
* <p>
* Calling with a null value for the list disables the restriction so that all services can be
* used, calling with an empty list only allows the built-in system services. Any non-system
* accessibility service that's currently enabled must be included in the list.
* <p>
* System accessibility services are always available to the user the list can't modify this.
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageNames List of accessibility service package names.
* @return {@code true} if the operation succeeded, or {@code false} if the list didn't
* contain every enabled non-system accessibility service.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public boolean setPermittedAccessibilityServices(@NonNull ComponentName admin,
List<String> packageNames) {
throwIfParentInstance("setPermittedAccessibilityServices");
if (mService != null) {
try {
return mService.setPermittedAccessibilityServices(admin, packageNames);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Returns the list of permitted accessibility services set by this device or profile owner.
* <p>
* An empty list means no accessibility services except system services are allowed. Null means
* all accessibility services are allowed.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return List of accessiblity service package names.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public @Nullable List<String> getPermittedAccessibilityServices(@NonNull ComponentName admin) {
throwIfParentInstance("getPermittedAccessibilityServices");
if (mService != null) {
try {
return mService.getPermittedAccessibilityServices(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by the system to check if a specific accessibility service is disabled by admin.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName Accessibility service package name that needs to be checked.
* @param userHandle user id the admin is running as.
* @return true if the accessibility service is permitted, otherwise false.
*
* @hide
*/
public boolean isAccessibilityServicePermittedByAdmin(@NonNull ComponentName admin,
@NonNull String packageName, int userHandle) {
if (mService != null) {
try {
return mService.isAccessibilityServicePermittedByAdmin(admin, packageName,
userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Returns the list of accessibility services permitted by the device or profiles
* owners of this user.
*
* <p>Null means all accessibility services are allowed, if a non-null list is returned
* it will contain the intersection of the permitted lists for any device or profile
* owners that apply to this user. It will also include any system accessibility services.
*
* @param userId which user to check for.
* @return List of accessiblity service package names.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public @Nullable List<String> getPermittedAccessibilityServices(int userId) {
throwIfParentInstance("getPermittedAccessibilityServices");
if (mService != null) {
try {
return mService.getPermittedAccessibilityServicesForUser(userId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by a profile or device owner to set the permitted input methods services for this
* user. By default, the user can use any input method.
* <p>
* When zero or more packages have been added, input method that are not in the list and not
* part of the system can not be enabled by the user. This method will fail if it is called for
* a admin that is not for the foreground user or a profile of the foreground user. Any
* non-system input method service that's currently enabled must be included in the list.
* <p>
* Calling with a null value for the list disables the restriction so that all input methods can
* be used, calling with an empty list disables all but the system's own input methods.
* <p>
* System input methods are always available to the user - this method can't modify this.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageNames List of input method package names.
* @return {@code true} if the operation succeeded, or {@code false} if the list didn't
* contain every enabled non-system input method service.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public boolean setPermittedInputMethods(
@NonNull ComponentName admin, List<String> packageNames) {
throwIfParentInstance("setPermittedInputMethods");
if (mService != null) {
try {
return mService.setPermittedInputMethods(admin, packageNames);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Returns the list of permitted input methods set by this device or profile owner.
* <p>
* An empty list means no input methods except system input methods are allowed. Null means all
* input methods are allowed.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return List of input method package names.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public @Nullable List<String> getPermittedInputMethods(@NonNull ComponentName admin) {
throwIfParentInstance("getPermittedInputMethods");
if (mService != null) {
try {
return mService.getPermittedInputMethods(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by the system to check if a specific input method is disabled by admin.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName Input method package name that needs to be checked.
* @param userHandle user id the admin is running as.
* @return true if the input method is permitted, otherwise false.
*
* @hide
*/
public boolean isInputMethodPermittedByAdmin(@NonNull ComponentName admin,
@NonNull String packageName, int userHandle) {
if (mService != null) {
try {
return mService.isInputMethodPermittedByAdmin(admin, packageName, userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Returns the list of input methods permitted by the device or profiles owners.
*
* <p>On {@link android.os.Build.VERSION_CODES#Q} and later devices, this method returns the
* result for the calling user.</p>
*
* <p>On Android P and prior devices, this method returns the result for the current user.</p>
*
* <p>Null means all input methods are allowed, if a non-null list is returned
* it will contain the intersection of the permitted lists for any device or profile
* owners that apply to this user. It will also include any system input methods.
*
* @return List of input method package names.
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public @Nullable List<String> getPermittedInputMethodsForCurrentUser() {
throwIfParentInstance("getPermittedInputMethodsForCurrentUser");
if (mService != null) {
try {
return mService.getPermittedInputMethodsForCurrentUser();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by a profile owner of a managed profile to set the packages that are allowed to use
* a {@link android.service.notification.NotificationListenerService} in the primary user to
* see notifications from the managed profile. By default all packages are permitted by this
* policy. When zero or more packages have been added, notification listeners installed on the
* primary user that are not in the list and are not part of the system won't receive events
* for managed profile notifications.
* <p>
* Calling with a {@code null} value for the list disables the restriction so that all
* notification listener services be used. Calling with an empty list disables all but the
* system's own notification listeners. System notification listener services are always
* available to the user.
* <p>
* If a device or profile owner want to stop notification listeners in their user from seeing
* that user's notifications they should prevent that service from running instead (e.g. via
* {@link #setApplicationHidden(ComponentName, String, boolean)})
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageList List of package names to whitelist
* @return true if setting the restriction succeeded. It will fail if called outside a managed
* profile
* @throws SecurityException if {@code admin} is not a profile owner.
*
* @see android.service.notification.NotificationListenerService
*/
public boolean setPermittedCrossProfileNotificationListeners(
@NonNull ComponentName admin, @Nullable List<String> packageList) {
throwIfParentInstance("setPermittedCrossProfileNotificationListeners");
if (mService != null) {
try {
return mService.setPermittedCrossProfileNotificationListeners(admin, packageList);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Returns the list of packages installed on the primary user that allowed to use a
* {@link android.service.notification.NotificationListenerService} to receive
* notifications from this managed profile, as set by the profile owner.
* <p>
* An empty list means no notification listener services except system ones are allowed.
* A {@code null} return value indicates that all notification listeners are allowed.
*/
public @Nullable List<String> getPermittedCrossProfileNotificationListeners(
@NonNull ComponentName admin) {
throwIfParentInstance("getPermittedCrossProfileNotificationListeners");
if (mService != null) {
try {
return mService.getPermittedCrossProfileNotificationListeners(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Returns true if {@code NotificationListenerServices} from the given package are allowed to
* receive events for notifications from the given user id. Can only be called by the system uid
*
* @see #setPermittedCrossProfileNotificationListeners(ComponentName, List)
*
* @hide
*/
public boolean isNotificationListenerServicePermitted(
@NonNull String packageName, @UserIdInt int userId) {
if (mService != null) {
try {
return mService.isNotificationListenerServicePermitted(packageName, userId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return true;
}
/**
* Get the list of apps to keep around as APKs even if no user has currently installed it. This
* function can be called by a device owner or by a delegate given the
* {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}.
* <p>
* Please note that packages returned in this method are not automatically pre-cached.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if the caller is a keep uninstalled packages delegate.
* @return List of package names to keep cached.
* @see #setDelegatedScopes
* @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES
*/
public @Nullable List<String> getKeepUninstalledPackages(@Nullable ComponentName admin) {
throwIfParentInstance("getKeepUninstalledPackages");
if (mService != null) {
try {
return mService.getKeepUninstalledPackages(admin, mContext.getPackageName());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Set a list of apps to keep around as APKs even if no user has currently installed it. This
* function can be called by a device owner or by a delegate given the
* {@link #DELEGATION_KEEP_UNINSTALLED_PACKAGES} scope via {@link #setDelegatedScopes}.
*
* <p>Please note that setting this policy does not imply that specified apps will be
* automatically pre-cached.</p>
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if the caller is a keep uninstalled packages delegate.
* @param packageNames List of package names to keep cached.
* @throws SecurityException if {@code admin} is not a device owner.
* @see #setDelegatedScopes
* @see #DELEGATION_KEEP_UNINSTALLED_PACKAGES
*/
public void setKeepUninstalledPackages(@Nullable ComponentName admin,
@NonNull List<String> packageNames) {
throwIfParentInstance("setKeepUninstalledPackages");
if (mService != null) {
try {
mService.setKeepUninstalledPackages(admin, mContext.getPackageName(), packageNames);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a device owner to create a user with the specified name. The UserHandle returned
* by this method should not be persisted as user handles are recycled as users are removed and
* created. If you need to persist an identifier for this user, use
* {@link UserManager#getSerialNumberForUser}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param name the user's name
* @see UserHandle
* @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
* user could not be created.
*
* @deprecated From {@link android.os.Build.VERSION_CODES#M}
* @removed From {@link android.os.Build.VERSION_CODES#N}
*/
@Deprecated
public @Nullable UserHandle createUser(@NonNull ComponentName admin, String name) {
return null;
}
/**
* Called by a device owner to create a user with the specified name. The UserHandle returned
* by this method should not be persisted as user handles are recycled as users are removed and
* created. If you need to persist an identifier for this user, use
* {@link UserManager#getSerialNumberForUser}. The new user will be started in the background
* immediately.
*
* <p> profileOwnerComponent is the {@link DeviceAdminReceiver} to be the profile owner as well
* as registered as an active admin on the new user. The profile owner package will be
* installed on the new user if it already is installed on the device.
*
* <p>If the optionalInitializeData is not null, then the extras will be passed to the
* profileOwnerComponent when onEnable is called.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param name the user's name
* @param ownerName the human readable name of the organisation associated with this DPM.
* @param profileOwnerComponent The {@link DeviceAdminReceiver} that will be an active admin on
* the user.
* @param adminExtras Extras that will be passed to onEnable of the admin receiver
* on the new user.
* @see UserHandle
* @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
* user could not be created.
*
* @deprecated From {@link android.os.Build.VERSION_CODES#M}
* @removed From {@link android.os.Build.VERSION_CODES#N}
*/
@Deprecated
public @Nullable UserHandle createAndInitializeUser(@NonNull ComponentName admin, String name,
String ownerName, @NonNull ComponentName profileOwnerComponent, Bundle adminExtras) {
return null;
}
/**
* Flag used by {@link #createAndManageUser} to skip setup wizard after creating a new user.
*/
public static final int SKIP_SETUP_WIZARD = 0x0001;
/**
* Flag used by {@link #createAndManageUser} to specify that the user should be created
* ephemeral. Ephemeral users will be removed after switching to another user or rebooting the
* device.
*/
public static final int MAKE_USER_EPHEMERAL = 0x0002;
/**
* Flag used by {@link #createAndManageUser} to specify that the user should be created as a
* demo user.
* @hide
*/
public static final int MAKE_USER_DEMO = 0x0004;
/**
* Flag used by {@link #createAndManageUser} to specify that the newly created user should skip
* the disabling of system apps during provisioning.
*/
public static final int LEAVE_ALL_SYSTEM_APPS_ENABLED = 0x0010;
/**
* @hide
*/
@IntDef(flag = true, prefix = { "SKIP_", "MAKE_USER_", "START_", "LEAVE_" }, value = {
SKIP_SETUP_WIZARD,
MAKE_USER_EPHEMERAL,
MAKE_USER_DEMO,
LEAVE_ALL_SYSTEM_APPS_ENABLED
})
@Retention(RetentionPolicy.SOURCE)
public @interface CreateAndManageUserFlags {}
/**
* Called by a device owner to create a user with the specified name and a given component of
* the calling package as profile owner. The UserHandle returned by this method should not be
* persisted as user handles are recycled as users are removed and created. If you need to
* persist an identifier for this user, use {@link UserManager#getSerialNumberForUser}. The new
* user will not be started in the background.
* <p>
* admin is the {@link DeviceAdminReceiver} which is the device owner. profileOwner is also a
* DeviceAdminReceiver in the same package as admin, and will become the profile owner and will
* be registered as an active admin on the new user. The profile owner package will be installed
* on the new user.
* <p>
* If the adminExtras are not null, they will be stored on the device until the user is started
* for the first time. Then the extras will be passed to the admin when onEnable is called.
* <p>From {@link android.os.Build.VERSION_CODES#P} onwards, if targeting
* {@link android.os.Build.VERSION_CODES#P}, throws {@link UserOperationException} instead of
* returning {@code null} on failure.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param name The user's name.
* @param profileOwner Which {@link DeviceAdminReceiver} will be profile owner. Has to be in the
* same package as admin, otherwise no user is created and an
* IllegalArgumentException is thrown.
* @param adminExtras Extras that will be passed to onEnable of the admin receiver on the new
* user.
* @param flags {@link #SKIP_SETUP_WIZARD}, {@link #MAKE_USER_EPHEMERAL} and
* {@link #LEAVE_ALL_SYSTEM_APPS_ENABLED} are supported.
* @see UserHandle
* @return the {@link android.os.UserHandle} object for the created user, or {@code null} if the
* user could not be created.
* @throws SecurityException if {@code admin} is not a device owner.
* @throws UserOperationException if the user could not be created and the calling app is
* targeting {@link android.os.Build.VERSION_CODES#P} and running on
* {@link android.os.Build.VERSION_CODES#P}.
*/
public @Nullable UserHandle createAndManageUser(@NonNull ComponentName admin,
@NonNull String name,
@NonNull ComponentName profileOwner, @Nullable PersistableBundle adminExtras,
@CreateAndManageUserFlags int flags) {
throwIfParentInstance("createAndManageUser");
try {
return mService.createAndManageUser(admin, name, profileOwner, adminExtras, flags);
} catch (ServiceSpecificException e) {
throw new UserOperationException(e.getMessage(), e.errorCode);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner to remove a user/profile and all associated data. The primary user
* can not be removed.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param userHandle the user to remove.
* @return {@code true} if the user was removed, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public boolean removeUser(@NonNull ComponentName admin, @NonNull UserHandle userHandle) {
throwIfParentInstance("removeUser");
try {
return mService.removeUser(admin, userHandle);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner to switch the specified secondary user to the foreground.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param userHandle the user to switch to; null will switch to primary.
* @return {@code true} if the switch was successful, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not a device owner.
* @see Intent#ACTION_USER_FOREGROUND
* @see #getSecondaryUsers(ComponentName)
*/
public boolean switchUser(@NonNull ComponentName admin, @Nullable UserHandle userHandle) {
throwIfParentInstance("switchUser");
try {
return mService.switchUser(admin, userHandle);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner to start the specified secondary user in background.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param userHandle the user to be started in background.
* @return one of the following result codes:
* {@link UserManager#USER_OPERATION_ERROR_UNKNOWN},
* {@link UserManager#USER_OPERATION_SUCCESS},
* {@link UserManager#USER_OPERATION_ERROR_MANAGED_PROFILE},
* {@link UserManager#USER_OPERATION_ERROR_MAX_RUNNING_USERS},
* @throws SecurityException if {@code admin} is not a device owner.
* @see #getSecondaryUsers(ComponentName)
*/
public @UserOperationResult int startUserInBackground(
@NonNull ComponentName admin, @NonNull UserHandle userHandle) {
throwIfParentInstance("startUserInBackground");
try {
return mService.startUserInBackground(admin, userHandle);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner to stop the specified secondary user.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param userHandle the user to be stopped.
* @return one of the following result codes:
* {@link UserManager#USER_OPERATION_ERROR_UNKNOWN},
* {@link UserManager#USER_OPERATION_SUCCESS},
* {@link UserManager#USER_OPERATION_ERROR_MANAGED_PROFILE},
* {@link UserManager#USER_OPERATION_ERROR_CURRENT_USER}
* @throws SecurityException if {@code admin} is not a device owner.
* @see #getSecondaryUsers(ComponentName)
*/
public @UserOperationResult int stopUser(
@NonNull ComponentName admin, @NonNull UserHandle userHandle) {
throwIfParentInstance("stopUser");
try {
return mService.stopUser(admin, userHandle);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a profile owner of secondary user that is affiliated with the device to stop the
* calling user and switch back to primary.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return one of the following result codes:
* {@link UserManager#USER_OPERATION_ERROR_UNKNOWN},
* {@link UserManager#USER_OPERATION_SUCCESS},
* {@link UserManager#USER_OPERATION_ERROR_MANAGED_PROFILE},
* {@link UserManager#USER_OPERATION_ERROR_CURRENT_USER}
* @throws SecurityException if {@code admin} is not a profile owner affiliated with the device.
* @see #getSecondaryUsers(ComponentName)
*/
public @UserOperationResult int logoutUser(@NonNull ComponentName admin) {
throwIfParentInstance("logoutUser");
try {
return mService.logoutUser(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner to list all secondary users on the device. Managed profiles are not
* considered as secondary users.
* <p> Used for various user management APIs, including {@link #switchUser}, {@link #removeUser}
* and {@link #stopUser}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return list of other {@link UserHandle}s on the device.
* @throws SecurityException if {@code admin} is not a device owner.
* @see #removeUser(ComponentName, UserHandle)
* @see #switchUser(ComponentName, UserHandle)
* @see #startUserInBackground(ComponentName, UserHandle)
* @see #stopUser(ComponentName, UserHandle)
*/
public List<UserHandle> getSecondaryUsers(@NonNull ComponentName admin) {
throwIfParentInstance("getSecondaryUsers");
try {
return mService.getSecondaryUsers(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks if the profile owner is running in an ephemeral user.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return whether the profile owner is running in an ephemeral user.
*/
public boolean isEphemeralUser(@NonNull ComponentName admin) {
throwIfParentInstance("isEphemeralUser");
try {
return mService.isEphemeralUser(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Retrieves the application restrictions for a given target application running in the calling
* user.
* <p>
* The caller must be a profile or device owner on that user, or the package allowed to manage
* application restrictions via {@link #setDelegatedScopes} with the
* {@link #DELEGATION_APP_RESTRICTIONS} scope; otherwise a security exception will be thrown.
*
* <p>NOTE: The method performs disk I/O and shouldn't be called on the main thread
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if called by the application restrictions managing package.
* @param packageName The name of the package to fetch restricted settings of.
* @return {@link Bundle} of settings corresponding to what was set last time
* {@link DevicePolicyManager#setApplicationRestrictions} was called, or an empty
* {@link Bundle} if no restrictions have been set.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setDelegatedScopes
* @see #DELEGATION_APP_RESTRICTIONS
*/
@WorkerThread
public @NonNull Bundle getApplicationRestrictions(
@Nullable ComponentName admin, String packageName) {
throwIfParentInstance("getApplicationRestrictions");
if (mService != null) {
try {
return mService.getApplicationRestrictions(admin, mContext.getPackageName(),
packageName);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by a profile or device owner to set a user restriction specified by the key.
* <p>
* The calling device admin must be a profile or device owner; if it is not, a security
* exception will be thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param key The key of the restriction. See the constants in {@link android.os.UserManager}
* for the list of keys.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void addUserRestriction(@NonNull ComponentName admin, String key) {
throwIfParentInstance("addUserRestriction");
if (mService != null) {
try {
mService.setUserRestriction(admin, key, true);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile or device owner to clear a user restriction specified by the key.
* <p>
* The calling device admin must be a profile or device owner; if it is not, a security
* exception will be thrown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param key The key of the restriction. See the constants in {@link android.os.UserManager}
* for the list of keys.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void clearUserRestriction(@NonNull ComponentName admin, String key) {
throwIfParentInstance("clearUserRestriction");
if (mService != null) {
try {
mService.setUserRestriction(admin, key, false);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a profile or device owner to get user restrictions set with
* {@link #addUserRestriction(ComponentName, String)}.
* <p>
* The target user may have more restrictions set by the system or other device owner / profile
* owner. To get all the user restrictions currently set, use
* {@link UserManager#getUserRestrictions()}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public @NonNull Bundle getUserRestrictions(@NonNull ComponentName admin) {
throwIfParentInstance("getUserRestrictions");
Bundle ret = null;
if (mService != null) {
try {
ret = mService.getUserRestrictions(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return ret == null ? new Bundle() : ret;
}
/**
* Called by any app to display a support dialog when a feature was disabled by an admin.
* This returns an intent that can be used with {@link Context#startActivity(Intent)} to
* display the dialog. It will tell the user that the feature indicated by {@code restriction}
* was disabled by an admin, and include a link for more information. The default content of
* the dialog can be changed by the restricting admin via
* {@link #setShortSupportMessage(ComponentName, CharSequence)}. If the restriction is not
* set (i.e. the feature is available), then the return value will be {@code null}.
* @param restriction Indicates for which feature the dialog should be displayed. Can be a
* user restriction from {@link UserManager}, e.g.
* {@link UserManager#DISALLOW_ADJUST_VOLUME}, or one of the constants
* {@link #POLICY_DISABLE_CAMERA} or {@link #POLICY_DISABLE_SCREEN_CAPTURE}.
* @return Intent An intent to be used to start the dialog-activity if the restriction is
* set by an admin, or null if the restriction does not exist or no admin set it.
*/
public Intent createAdminSupportIntent(@NonNull String restriction) {
throwIfParentInstance("createAdminSupportIntent");
if (mService != null) {
try {
return mService.createAdminSupportIntent(restriction);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Hide or unhide packages. When a package is hidden it is unavailable for use, but the data and
* actual package file remain. This function can be called by a device owner, profile owner, or
* by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
* {@link #setDelegatedScopes}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if the caller is a package access delegate.
* @param packageName The name of the package to hide or unhide.
* @param hidden {@code true} if the package should be hidden, {@code false} if it should be
* unhidden.
* @return boolean Whether the hidden setting of the package was successfully updated.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setDelegatedScopes
* @see #DELEGATION_PACKAGE_ACCESS
*/
public boolean setApplicationHidden(@NonNull ComponentName admin, String packageName,
boolean hidden) {
throwIfParentInstance("setApplicationHidden");
if (mService != null) {
try {
return mService.setApplicationHidden(admin, mContext.getPackageName(), packageName,
hidden);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Determine if a package is hidden. This function can be called by a device owner, profile
* owner, or by a delegate given the {@link #DELEGATION_PACKAGE_ACCESS} scope via
* {@link #setDelegatedScopes}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if the caller is a package access delegate.
* @param packageName The name of the package to retrieve the hidden status of.
* @return boolean {@code true} if the package is hidden, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setDelegatedScopes
* @see #DELEGATION_PACKAGE_ACCESS
*/
public boolean isApplicationHidden(@NonNull ComponentName admin, String packageName) {
throwIfParentInstance("isApplicationHidden");
if (mService != null) {
try {
return mService.isApplicationHidden(admin, mContext.getPackageName(), packageName);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Re-enable a system app that was disabled by default when the user was initialized. This
* function can be called by a device owner, profile owner, or by a delegate given the
* {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if the caller is an enable system app delegate.
* @param packageName The package to be re-enabled in the calling profile.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setDelegatedScopes
* @see #DELEGATION_PACKAGE_ACCESS
*/
public void enableSystemApp(@NonNull ComponentName admin, String packageName) {
throwIfParentInstance("enableSystemApp");
if (mService != null) {
try {
mService.enableSystemApp(admin, mContext.getPackageName(), packageName);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Re-enable system apps by intent that were disabled by default when the user was initialized.
* This function can be called by a device owner, profile owner, or by a delegate given the
* {@link #DELEGATION_ENABLE_SYSTEM_APP} scope via {@link #setDelegatedScopes}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if the caller is an enable system app delegate.
* @param intent An intent matching the app(s) to be installed. All apps that resolve for this
* intent will be re-enabled in the calling profile.
* @return int The number of activities that matched the intent and were installed.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setDelegatedScopes
* @see #DELEGATION_PACKAGE_ACCESS
*/
public int enableSystemApp(@NonNull ComponentName admin, Intent intent) {
throwIfParentInstance("enableSystemApp");
if (mService != null) {
try {
return mService.enableSystemAppWithIntent(admin, mContext.getPackageName(), intent);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Install an existing package that has been installed in another user, or has been kept after
* removal via {@link #setKeepUninstalledPackages}.
* This function can be called by a device owner, profile owner or a delegate given
* the {@link #DELEGATION_INSTALL_EXISTING_PACKAGE} scope via {@link #setDelegatedScopes}.
* When called in a secondary user or managed profile, the user/profile must be affiliated with
* the device. See {@link #isAffiliatedUser}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName The package to be installed in the calling profile.
* @return {@code true} if the app is installed; {@code false} otherwise.
* @throws SecurityException if {@code admin} is not the device owner, or the profile owner of
* an affiliated user or profile.
* @see #setKeepUninstalledPackages
* @see #setDelegatedScopes
* @see #isAffiliatedUser
* @see #DELEGATION_PACKAGE_ACCESS
*/
public boolean installExistingPackage(@NonNull ComponentName admin, String packageName) {
throwIfParentInstance("installExistingPackage");
if (mService != null) {
try {
return mService.installExistingPackage(admin, mContext.getPackageName(),
packageName);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by a device owner or profile owner to disable account management for a specific type
* of account.
* <p>
* The calling device admin must be a device owner or profile owner. If it is not, a security
* exception will be thrown.
* <p>
* When account management is disabled for an account type, adding or removing an account of
* that type will not be possible.
* <p>
* From {@link android.os.Build.VERSION_CODES#N} the profile or device owner can still use
* {@link android.accounts.AccountManager} APIs to add or remove accounts when account
* management for a specific type is disabled.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param accountType For which account management is disabled or enabled.
* @param disabled The boolean indicating that account management will be disabled (true) or
* enabled (false).
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void setAccountManagementDisabled(@NonNull ComponentName admin, String accountType,
boolean disabled) {
throwIfParentInstance("setAccountManagementDisabled");
if (mService != null) {
try {
mService.setAccountManagementDisabled(admin, accountType, disabled);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Gets the array of accounts for which account management is disabled by the profile owner.
*
* <p> Account management can be disabled/enabled by calling
* {@link #setAccountManagementDisabled}.
*
* @return a list of account types for which account management has been disabled.
*
* @see #setAccountManagementDisabled
*/
public @Nullable String[] getAccountTypesWithManagementDisabled() {
throwIfParentInstance("getAccountTypesWithManagementDisabled");
return getAccountTypesWithManagementDisabledAsUser(myUserId());
}
/**
* @see #getAccountTypesWithManagementDisabled()
* @hide
*/
public @Nullable String[] getAccountTypesWithManagementDisabledAsUser(int userId) {
if (mService != null) {
try {
return mService.getAccountTypesWithManagementDisabledAsUser(userId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Sets which packages may enter lock task mode.
* <p>
* Any packages that share uid with an allowed package will also be allowed to activate lock
* task. From {@link android.os.Build.VERSION_CODES#M} removing packages from the lock task
* package list results in locked tasks belonging to those packages to be finished.
* <p>
* This function can only be called by the device owner, a profile owner of an affiliated user
* or profile, or the profile owner when no device owner is set. See {@link #isAffiliatedUser}.
* Any package set via this method will be cleared if the user becomes unaffiliated.
*
* @param packages The list of packages allowed to enter lock task mode
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not the device owner, the profile owner of an
* affiliated user or profile, or the profile owner when no device owner is set.
* @see #isAffiliatedUser
* @see Activity#startLockTask()
* @see DeviceAdminReceiver#onLockTaskModeEntering(Context, Intent, String)
* @see DeviceAdminReceiver#onLockTaskModeExiting(Context, Intent)
* @see UserManager#DISALLOW_CREATE_WINDOWS
*/
public void setLockTaskPackages(@NonNull ComponentName admin, @NonNull String[] packages)
throws SecurityException {
throwIfParentInstance("setLockTaskPackages");
if (mService != null) {
try {
mService.setLockTaskPackages(admin, packages);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Returns the list of packages allowed to start the lock task mode.
*
* @throws SecurityException if {@code admin} is not the device owner, the profile owner of an
* affiliated user or profile, or the profile owner when no device owner is set.
* @see #isAffiliatedUser
* @see #setLockTaskPackages
*/
public @NonNull String[] getLockTaskPackages(@NonNull ComponentName admin) {
throwIfParentInstance("getLockTaskPackages");
if (mService != null) {
try {
return mService.getLockTaskPackages(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return new String[0];
}
/**
* This function lets the caller know whether the given component is allowed to start the
* lock task mode.
* @param pkg The package to check
*/
public boolean isLockTaskPermitted(String pkg) {
throwIfParentInstance("isLockTaskPermitted");
if (mService != null) {
try {
return mService.isLockTaskPermitted(pkg);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Sets which system features are enabled when the device runs in lock task mode. This method
* doesn't affect the features when lock task mode is inactive. Any system features not included
* in {@code flags} are implicitly disabled when calling this method. By default, only
* {@link #LOCK_TASK_FEATURE_GLOBAL_ACTIONS} is enabled; all the other features are disabled. To
* disable the global actions dialog, call this method omitting
* {@link #LOCK_TASK_FEATURE_GLOBAL_ACTIONS}.
*
* <p>This method can only be called by the device owner, a profile owner of an affiliated
* user or profile, or the profile owner when no device owner is set. See
* {@link #isAffiliatedUser}.
* Any features set using this method are cleared if the user becomes unaffiliated.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param flags The system features enabled during lock task mode.
* @throws SecurityException if {@code admin} is not the device owner, the profile owner of an
* affiliated user or profile, or the profile owner when no device owner is set.
* @see #isAffiliatedUser
**/
public void setLockTaskFeatures(@NonNull ComponentName admin, @LockTaskFeature int flags) {
throwIfParentInstance("setLockTaskFeatures");
if (mService != null) {
try {
mService.setLockTaskFeatures(admin, flags);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Gets which system features are enabled for LockTask mode.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return bitfield of flags. See {@link #setLockTaskFeatures(ComponentName, int)} for a list.
* @throws SecurityException if {@code admin} is not the device owner, the profile owner of an
* affiliated user or profile, or the profile owner when no device owner is set.
* @see #isAffiliatedUser
* @see #setLockTaskFeatures
*/
public @LockTaskFeature int getLockTaskFeatures(@NonNull ComponentName admin) {
throwIfParentInstance("getLockTaskFeatures");
if (mService != null) {
try {
return mService.getLockTaskFeatures(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return 0;
}
/**
* Called by device owner to update {@link android.provider.Settings.Global} settings.
* Validation that the value of the setting is in the correct form for the setting type should
* be performed by the caller.
* <p>
* The settings that can be updated with this method are:
* <ul>
* <li>{@link android.provider.Settings.Global#ADB_ENABLED}</li>
* <li>{@link android.provider.Settings.Global#AUTO_TIME}</li>
* <li>{@link android.provider.Settings.Global#AUTO_TIME_ZONE}</li>
* <li>{@link android.provider.Settings.Global#DATA_ROAMING}</li>
* <li>{@link android.provider.Settings.Global#USB_MASS_STORAGE_ENABLED}</li>
* <li>{@link android.provider.Settings.Global#WIFI_SLEEP_POLICY}</li>
* <li>{@link android.provider.Settings.Global#STAY_ON_WHILE_PLUGGED_IN} This setting is only
* available from {@link android.os.Build.VERSION_CODES#M} onwards and can only be set if
* {@link #setMaximumTimeToLock} is not used to set a timeout.</li>
* <li>{@link android.provider.Settings.Global#WIFI_DEVICE_OWNER_CONFIGS_LOCKDOWN}</li> This
* setting is only available from {@link android.os.Build.VERSION_CODES#M} onwards.</li>
* </ul>
* <p>
* Changing the following settings has no effect as of {@link android.os.Build.VERSION_CODES#M}:
* <ul>
* <li>{@link android.provider.Settings.Global#BLUETOOTH_ON}. Use
* {@link android.bluetooth.BluetoothAdapter#enable()} and
* {@link android.bluetooth.BluetoothAdapter#disable()} instead.</li>
* <li>{@link android.provider.Settings.Global#DEVELOPMENT_SETTINGS_ENABLED}</li>
* <li>{@link android.provider.Settings.Global#MODE_RINGER}. Use
* {@link android.media.AudioManager#setRingerMode(int)} instead.</li>
* <li>{@link android.provider.Settings.Global#NETWORK_PREFERENCE}</li>
* <li>{@link android.provider.Settings.Global#WIFI_ON}. Use
* {@link android.net.wifi.WifiManager#setWifiEnabled(boolean)} instead.</li>
* </ul>
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param setting The name of the setting to update.
* @param value The value to update the setting to.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public void setGlobalSetting(@NonNull ComponentName admin, String setting, String value) {
throwIfParentInstance("setGlobalSetting");
if (mService != null) {
try {
mService.setGlobalSetting(admin, setting, value);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/** @hide */
@StringDef({
Settings.System.SCREEN_BRIGHTNESS_MODE,
Settings.System.SCREEN_BRIGHTNESS,
Settings.System.SCREEN_OFF_TIMEOUT
})
@Retention(RetentionPolicy.SOURCE)
public @interface SystemSettingsWhitelist {}
/**
* Called by a device or profile owner to update {@link android.provider.Settings.System}
* settings. Validation that the value of the setting is in the correct form for the setting
* type should be performed by the caller.
* <p>
* The settings that can be updated by a device owner or profile owner of secondary user with
* this method are:
* <ul>
* <li>{@link android.provider.Settings.System#SCREEN_BRIGHTNESS}</li>
* <li>{@link android.provider.Settings.System#SCREEN_BRIGHTNESS_MODE}</li>
* <li>{@link android.provider.Settings.System#SCREEN_OFF_TIMEOUT}</li>
* </ul>
* <p>
*
* @see android.provider.Settings.System#SCREEN_OFF_TIMEOUT
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param setting The name of the setting to update.
* @param value The value to update the setting to.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void setSystemSetting(@NonNull ComponentName admin,
@NonNull @SystemSettingsWhitelist String setting, String value) {
throwIfParentInstance("setSystemSetting");
if (mService != null) {
try {
mService.setSystemSetting(admin, setting, value);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by device owner to set the system wall clock time. This only takes effect if called
* when {@link android.provider.Settings.Global#AUTO_TIME} is 0, otherwise {@code false} will be
* returned.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with
* @param millis time in milliseconds since the Epoch
* @return {@code true} if set time succeeded, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public boolean setTime(@NonNull ComponentName admin, long millis) {
throwIfParentInstance("setTime");
if (mService != null) {
try {
return mService.setTime(admin, millis);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by device owner to set the system's persistent default time zone. This only takes
* effect if called when {@link android.provider.Settings.Global#AUTO_TIME_ZONE} is 0, otherwise
* {@code false} will be returned.
*
* @see android.app.AlarmManager#setTimeZone(String)
* @param admin Which {@link DeviceAdminReceiver} this request is associated with
* @param timeZone one of the Olson ids from the list returned by
* {@link java.util.TimeZone#getAvailableIDs}
* @return {@code true} if set timezone succeeded, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public boolean setTimeZone(@NonNull ComponentName admin, String timeZone) {
throwIfParentInstance("setTimeZone");
if (mService != null) {
try {
return mService.setTimeZone(admin, timeZone);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by profile or device owners to update {@link android.provider.Settings.Secure}
* settings. Validation that the value of the setting is in the correct form for the setting
* type should be performed by the caller.
* <p>
* The settings that can be updated by a profile or device owner with this method are:
* <ul>
* <li>{@link android.provider.Settings.Secure#DEFAULT_INPUT_METHOD}</li>
* <li>{@link android.provider.Settings.Secure#SKIP_FIRST_USE_HINTS}</li>
* </ul>
* <p>
* A device owner can additionally update the following settings:
* <ul>
* <li>{@link android.provider.Settings.Secure#LOCATION_MODE}</li>
* </ul>
*
* <strong>Note: Starting from Android O, apps should no longer call this method with the
* setting {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS}, which is
* deprecated. Instead, device owners or profile owners should use the restriction
* {@link UserManager#DISALLOW_INSTALL_UNKNOWN_SOURCES}.
* If any app targeting {@link android.os.Build.VERSION_CODES#O} or higher calls this method
* with {@link android.provider.Settings.Secure#INSTALL_NON_MARKET_APPS},
* an {@link UnsupportedOperationException} is thrown.
*
* Starting from Android Q, the device and profile owner can also call
* {@link UserManager#DISALLOW_INSTALL_UNKNOWN_SOURCES_GLOBALLY} to restrict unknown sources for
* all users.
* </strong>
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param setting The name of the setting to update.
* @param value The value to update the setting to.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void setSecureSetting(@NonNull ComponentName admin, String setting, String value) {
throwIfParentInstance("setSecureSetting");
if (mService != null) {
try {
mService.setSecureSetting(admin, setting, value);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Designates a specific service component as the provider for making permission requests of a
* local or remote administrator of the user.
* <p/>
* Only a profile owner can designate the restrictions provider.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param provider The component name of the service that implements
* {@link RestrictionsReceiver}. If this param is null, it removes the restrictions
* provider previously assigned.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void setRestrictionsProvider(@NonNull ComponentName admin,
@Nullable ComponentName provider) {
throwIfParentInstance("setRestrictionsProvider");
if (mService != null) {
try {
mService.setRestrictionsProvider(admin, provider);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* Called by profile or device owners to set the master volume mute on or off.
* This has no effect when set on a managed profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param on {@code true} to mute master volume, {@code false} to turn mute off.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void setMasterVolumeMuted(@NonNull ComponentName admin, boolean on) {
throwIfParentInstance("setMasterVolumeMuted");
if (mService != null) {
try {
mService.setMasterVolumeMuted(admin, on);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* Called by profile or device owners to check whether the master volume mute is on or off.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return {@code true} if master volume is muted, {@code false} if it's not.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public boolean isMasterVolumeMuted(@NonNull ComponentName admin) {
throwIfParentInstance("isMasterVolumeMuted");
if (mService != null) {
try {
return mService.isMasterVolumeMuted(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* Change whether a user can uninstall a package. This function can be called by a device owner,
* profile owner, or by a delegate given the {@link #DELEGATION_BLOCK_UNINSTALL} scope via
* {@link #setDelegatedScopes}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if the caller is a block uninstall delegate.
* @param packageName package to change.
* @param uninstallBlocked true if the user shouldn't be able to uninstall the package.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setDelegatedScopes
* @see #DELEGATION_BLOCK_UNINSTALL
*/
public void setUninstallBlocked(@Nullable ComponentName admin, String packageName,
boolean uninstallBlocked) {
throwIfParentInstance("setUninstallBlocked");
if (mService != null) {
try {
mService.setUninstallBlocked(admin, mContext.getPackageName(), packageName,
uninstallBlocked);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* Check whether the user has been blocked by device policy from uninstalling a package.
* Requires the caller to be the profile owner if checking a specific admin's policy.
* <p>
* <strong>Note:</strong> Starting from {@link android.os.Build.VERSION_CODES#LOLLIPOP_MR1}, the
* behavior of this API is changed such that passing {@code null} as the {@code admin} parameter
* will return if any admin has blocked the uninstallation. Before L MR1, passing {@code null}
* will cause a NullPointerException to be raised.
*
* @param admin The name of the admin component whose blocking policy will be checked, or
* {@code null} to check whether any admin has blocked the uninstallation.
* @param packageName package to check.
* @return true if uninstallation is blocked.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public boolean isUninstallBlocked(@Nullable ComponentName admin, String packageName) {
throwIfParentInstance("isUninstallBlocked");
if (mService != null) {
try {
return mService.isUninstallBlocked(admin, packageName);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by the profile owner of a managed profile to enable widget providers from a given
* package to be available in the parent profile. As a result the user will be able to add
* widgets from the white-listed package running under the profile to a widget host which runs
* under the parent profile, for example the home screen. Note that a package may have zero or
* more provider components, where each component provides a different widget type.
* <p>
* <strong>Note:</strong> By default no widget provider package is white-listed.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName The package from which widget providers are white-listed.
* @return Whether the package was added.
* @throws SecurityException if {@code admin} is not a profile owner.
* @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
* @see #getCrossProfileWidgetProviders(android.content.ComponentName)
*/
public boolean addCrossProfileWidgetProvider(@NonNull ComponentName admin, String packageName) {
throwIfParentInstance("addCrossProfileWidgetProvider");
if (mService != null) {
try {
return mService.addCrossProfileWidgetProvider(admin, packageName);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by the profile owner of a managed profile to disable widget providers from a given
* package to be available in the parent profile. For this method to take effect the package
* should have been added via
* {@link #addCrossProfileWidgetProvider( android.content.ComponentName, String)}.
* <p>
* <strong>Note:</strong> By default no widget provider package is white-listed.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName The package from which widget providers are no longer white-listed.
* @return Whether the package was removed.
* @throws SecurityException if {@code admin} is not a profile owner.
* @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
* @see #getCrossProfileWidgetProviders(android.content.ComponentName)
*/
public boolean removeCrossProfileWidgetProvider(
@NonNull ComponentName admin, String packageName) {
throwIfParentInstance("removeCrossProfileWidgetProvider");
if (mService != null) {
try {
return mService.removeCrossProfileWidgetProvider(admin, packageName);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by the profile owner of a managed profile to query providers from which packages are
* available in the parent profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return The white-listed package list.
* @see #addCrossProfileWidgetProvider(android.content.ComponentName, String)
* @see #removeCrossProfileWidgetProvider(android.content.ComponentName, String)
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public @NonNull List<String> getCrossProfileWidgetProviders(@NonNull ComponentName admin) {
throwIfParentInstance("getCrossProfileWidgetProviders");
if (mService != null) {
try {
List<String> providers = mService.getCrossProfileWidgetProviders(admin);
if (providers != null) {
return providers;
}
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return Collections.emptyList();
}
/**
* Called by profile or device owners to set the user's photo.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param icon the bitmap to set as the photo.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void setUserIcon(@NonNull ComponentName admin, Bitmap icon) {
throwIfParentInstance("setUserIcon");
try {
mService.setUserIcon(admin, icon);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by device owners to set a local system update policy. When a new policy is set,
* {@link #ACTION_SYSTEM_UPDATE_POLICY_CHANGED} is broadcasted.
* <p>
* If the supplied system update policy has freeze periods set but the freeze periods do not
* meet 90-day maximum length or 60-day minimum separation requirement set out in
* {@link SystemUpdatePolicy#setFreezePeriods},
* {@link SystemUpdatePolicy.ValidationFailedException} will the thrown. Note that the system
* keeps a record of freeze periods the device experienced previously, and combines them with
* the new freeze periods to be set when checking the maximum freeze length and minimum freeze
* separation constraints. As a result, freeze periods that passed validation during
* {@link SystemUpdatePolicy#setFreezePeriods} might fail the additional checks here due to
* the freeze period history. If this is causing issues during development,
* {@code adb shell dpm clear-freeze-period-record} can be used to clear the record.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with. All
* components in the device owner package can set system update policies and the most
* recent policy takes effect.
* @param policy the new policy, or {@code null} to clear the current policy.
* @throws SecurityException if {@code admin} is not a device owner.
* @throws IllegalArgumentException if the policy type or maintenance window is not valid.
* @throws SystemUpdatePolicy.ValidationFailedException if the policy's freeze period does not
* meet the requirement.
* @see SystemUpdatePolicy
* @see SystemUpdatePolicy#setFreezePeriods(List)
*/
public void setSystemUpdatePolicy(@NonNull ComponentName admin, SystemUpdatePolicy policy) {
throwIfParentInstance("setSystemUpdatePolicy");
if (mService != null) {
try {
mService.setSystemUpdatePolicy(admin, policy);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* Retrieve a local system update policy set previously by {@link #setSystemUpdatePolicy}.
*
* @return The current policy object, or {@code null} if no policy is set.
*/
public @Nullable SystemUpdatePolicy getSystemUpdatePolicy() {
throwIfParentInstance("getSystemUpdatePolicy");
if (mService != null) {
try {
return mService.getSystemUpdatePolicy();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return null;
}
/**
* Reset record of previous system update freeze period the device went through.
* Only callable by ADB.
* @hide
*/
public void clearSystemUpdatePolicyFreezePeriodRecord() {
throwIfParentInstance("clearSystemUpdatePolicyFreezePeriodRecord");
if (mService == null) {
return;
}
try {
mService.clearSystemUpdatePolicyFreezePeriodRecord();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner or profile owner of secondary users that is affiliated with the
* device to disable the keyguard altogether.
* <p>
* Setting the keyguard to disabled has the same effect as choosing "None" as the screen lock
* type. However, this call has no effect if a password, pin or pattern is currently set. If a
* password, pin or pattern is set after the keyguard was disabled, the keyguard stops being
* disabled.
*
* <p>
* As of {@link android.os.Build.VERSION_CODES#P}, this call also dismisses the
* keyguard if it is currently shown.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param disabled {@code true} disables the keyguard, {@code false} reenables it.
* @return {@code false} if attempting to disable the keyguard while a lock password was in
* place. {@code true} otherwise.
* @throws SecurityException if {@code admin} is not the device owner, or a profile owner of
* secondary user that is affiliated with the device.
* @see #isAffiliatedUser
* @see #getSecondaryUsers
*/
public boolean setKeyguardDisabled(@NonNull ComponentName admin, boolean disabled) {
throwIfParentInstance("setKeyguardDisabled");
try {
return mService.setKeyguardDisabled(admin, disabled);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by device owner or profile owner of secondary users that is affiliated with the
* device to disable the status bar. Disabling the status bar blocks notifications, quick
* settings and other screen overlays that allow escaping from a single use device.
* <p>
* <strong>Note:</strong> This method has no effect for LockTask mode. The behavior of the
* status bar in LockTask mode can be configured with
* {@link #setLockTaskFeatures(ComponentName, int)}. Calls to this method when the device is in
* LockTask mode will be registered, but will only take effect when the device leaves LockTask
* mode.
*
* <p>This policy does not have any effect while on the lock screen, where the status bar will
* not be disabled. Using LockTask instead of this method is recommended.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param disabled {@code true} disables the status bar, {@code false} reenables it.
* @return {@code false} if attempting to disable the status bar failed. {@code true} otherwise.
* @throws SecurityException if {@code admin} is not the device owner, or a profile owner of
* secondary user that is affiliated with the device.
* @see #isAffiliatedUser
* @see #getSecondaryUsers
*/
public boolean setStatusBarDisabled(@NonNull ComponentName admin, boolean disabled) {
throwIfParentInstance("setStatusBarDisabled");
try {
return mService.setStatusBarDisabled(admin, disabled);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the system update service to notify device and profile owners of pending system
* updates.
*
* This method should only be used when it is unknown whether the pending system
* update is a security patch. Otherwise, use
* {@link #notifyPendingSystemUpdate(long, boolean)}.
*
* @param updateReceivedTime The time as given by {@link System#currentTimeMillis()}
* indicating when the current pending update was first available. {@code -1} if no
* update is available.
* @see #notifyPendingSystemUpdate(long, boolean)
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.NOTIFY_PENDING_SYSTEM_UPDATE)
public void notifyPendingSystemUpdate(long updateReceivedTime) {
throwIfParentInstance("notifyPendingSystemUpdate");
if (mService != null) {
try {
mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime));
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* Called by the system update service to notify device and profile owners of pending system
* updates.
*
* This method should be used instead of {@link #notifyPendingSystemUpdate(long)}
* when it is known whether the pending system update is a security patch.
*
* @param updateReceivedTime The time as given by {@link System#currentTimeMillis()}
* indicating when the current pending update was first available. {@code -1} if no
* update is available.
* @param isSecurityPatch {@code true} if this system update is purely a security patch;
* {@code false} if not.
* @see #notifyPendingSystemUpdate(long)
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.NOTIFY_PENDING_SYSTEM_UPDATE)
public void notifyPendingSystemUpdate(long updateReceivedTime, boolean isSecurityPatch) {
throwIfParentInstance("notifyPendingSystemUpdate");
if (mService != null) {
try {
mService.notifyPendingSystemUpdate(SystemUpdateInfo.of(updateReceivedTime,
isSecurityPatch));
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
}
/**
* Called by device or profile owners to get information about a pending system update.
*
* @param admin Which profile or device owner this request is associated with.
* @return Information about a pending system update or {@code null} if no update pending.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see DeviceAdminReceiver#onSystemUpdatePending(Context, Intent, long)
*/
public @Nullable SystemUpdateInfo getPendingSystemUpdate(@NonNull ComponentName admin) {
throwIfParentInstance("getPendingSystemUpdate");
try {
return mService.getPendingSystemUpdate(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Set the default response for future runtime permission requests by applications. This
* function can be called by a device owner, profile owner, or by a delegate given the
* {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
* The policy can allow for normal operation which prompts the user to grant a permission, or
* can allow automatic granting or denying of runtime permission requests by an application.
* This also applies to new permissions declared by app updates. When a permission is denied or
* granted this way, the effect is equivalent to setting the permission * grant state via
* {@link #setPermissionGrantState}.
* <p/>
* As this policy only acts on runtime permission requests, it only applies to applications
* built with a {@code targetSdkVersion} of {@link android.os.Build.VERSION_CODES#M} or later.
*
* @param admin Which profile or device owner this request is associated with.
* @param policy One of the policy constants {@link #PERMISSION_POLICY_PROMPT},
* {@link #PERMISSION_POLICY_AUTO_GRANT} and {@link #PERMISSION_POLICY_AUTO_DENY}.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setPermissionGrantState
* @see #setDelegatedScopes
* @see #DELEGATION_PERMISSION_GRANT
*/
public void setPermissionPolicy(@NonNull ComponentName admin, int policy) {
throwIfParentInstance("setPermissionPolicy");
try {
mService.setPermissionPolicy(admin, mContext.getPackageName(), policy);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the current runtime permission policy set by the device or profile owner. The
* default is {@link #PERMISSION_POLICY_PROMPT}.
*
* @param admin Which profile or device owner this request is associated with.
* @return the current policy for future permission requests.
*/
public int getPermissionPolicy(ComponentName admin) {
throwIfParentInstance("getPermissionPolicy");
try {
return mService.getPermissionPolicy(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Sets the grant state of a runtime permission for a specific application. The state can be
* {@link #PERMISSION_GRANT_STATE_DEFAULT default} in which a user can manage it through the UI,
* {@link #PERMISSION_GRANT_STATE_DENIED denied}, in which the permission is denied and the user
* cannot manage it through the UI, and {@link #PERMISSION_GRANT_STATE_GRANTED granted} in which
* the permission is granted and the user cannot manage it through the UI. This method can only
* be called by a profile owner, device owner, or a delegate given the
* {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
* <p/>
* Note that user cannot manage other permissions in the affected group through the UI
* either and their granted state will be kept as the current value. Thus, it's recommended that
* you set the grant state of all the permissions in the affected group.
* <p/>
* Setting the grant state to {@link #PERMISSION_GRANT_STATE_DEFAULT default} does not revoke
* the permission. It retains the previous grant, if any.
* <p/>
* Device admins with a {@code targetSdkVersion} < {@link android.os.Build.VERSION_CODES#Q}
* cannot grant and revoke permissions for applications built with a {@code targetSdkVersion}
* < {@link android.os.Build.VERSION_CODES#M}.
* <p/>
* Admins with a {@code targetSdkVersion} ≥ {@link android.os.Build.VERSION_CODES#Q} can
* grant and revoke permissions of all apps. Similar to the user revoking a permission from a
* application built with a {@code targetSdkVersion} <
* {@link android.os.Build.VERSION_CODES#M} the app-op matching the permission is set to
* {@link android.app.AppOpsManager#MODE_IGNORED}, but the permission stays granted.
*
* @param admin Which profile or device owner this request is associated with.
* @param packageName The application to grant or revoke a permission to.
* @param permission The permission to grant or revoke.
* @param grantState The permission grant state which is one of
* {@link #PERMISSION_GRANT_STATE_DENIED}, {@link #PERMISSION_GRANT_STATE_DEFAULT},
* {@link #PERMISSION_GRANT_STATE_GRANTED},
* @return whether the permission was successfully granted or revoked.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #PERMISSION_GRANT_STATE_DENIED
* @see #PERMISSION_GRANT_STATE_DEFAULT
* @see #PERMISSION_GRANT_STATE_GRANTED
* @see #setDelegatedScopes
* @see #DELEGATION_PERMISSION_GRANT
*/
public boolean setPermissionGrantState(@NonNull ComponentName admin,
@NonNull String packageName, @NonNull String permission,
@PermissionGrantState int grantState) {
throwIfParentInstance("setPermissionGrantState");
try {
CompletableFuture<Boolean> result = new CompletableFuture<>();
mService.setPermissionGrantState(admin, mContext.getPackageName(), packageName,
permission, grantState, new RemoteCallback((b) -> result.complete(b != null)));
// Timeout
BackgroundThread.getHandler().sendMessageDelayed(
obtainMessage(CompletableFuture::complete, result, false),
20_000);
return result.get();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
} catch (InterruptedException | ExecutionException e) {
throw new RuntimeException(e);
}
}
/**
* Returns the current grant state of a runtime permission for a specific application. This
* function can be called by a device owner, profile owner, or by a delegate given the
* {@link #DELEGATION_PERMISSION_GRANT} scope via {@link #setDelegatedScopes}.
*
* @param admin Which profile or device owner this request is associated with, or {@code null}
* if the caller is a permission grant delegate.
* @param packageName The application to check the grant state for.
* @param permission The permission to check for.
* @return the current grant state specified by device policy. If the profile or device owner
* has not set a grant state, the return value is
* {@link #PERMISSION_GRANT_STATE_DEFAULT}. This does not indicate whether or not the
* permission is currently granted for the package.
* <p/>
* If a grant state was set by the profile or device owner, then the return value will
* be one of {@link #PERMISSION_GRANT_STATE_DENIED} or
* {@link #PERMISSION_GRANT_STATE_GRANTED}, which indicates if the permission is
* currently denied or granted.
* @throws SecurityException if {@code admin} is not a device or profile owner.
* @see #setPermissionGrantState(ComponentName, String, String, int)
* @see PackageManager#checkPermission(String, String)
* @see #setDelegatedScopes
* @see #DELEGATION_PERMISSION_GRANT
*/
public @PermissionGrantState int getPermissionGrantState(@Nullable ComponentName admin,
@NonNull String packageName, @NonNull String permission) {
throwIfParentInstance("getPermissionGrantState");
try {
return mService.getPermissionGrantState(admin, mContext.getPackageName(), packageName,
permission);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether it is possible for the caller to initiate provisioning of a managed profile
* or device, setting itself as the device or profile owner.
*
* @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
* {@link #ACTION_PROVISION_MANAGED_PROFILE}.
* @return whether provisioning a managed profile or device is possible.
* @throws IllegalArgumentException if the supplied action is not valid.
*/
public boolean isProvisioningAllowed(@NonNull String action) {
throwIfParentInstance("isProvisioningAllowed");
try {
return mService.isProvisioningAllowed(action, mContext.getPackageName());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Checks whether it is possible to initiate provisioning a managed device,
* profile or user, setting the given package as owner.
*
* @param action One of {@link #ACTION_PROVISION_MANAGED_DEVICE},
* {@link #ACTION_PROVISION_MANAGED_PROFILE},
* {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE},
* {@link #ACTION_PROVISION_MANAGED_USER}
* @param packageName The package of the component that would be set as device, user, or profile
* owner.
* @return A {@link ProvisioningPreCondition} value indicating whether provisioning is allowed.
* @hide
*/
public @ProvisioningPreCondition int checkProvisioningPreCondition(
String action, @NonNull String packageName) {
try {
return mService.checkProvisioningPreCondition(action, packageName);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Return if this user is a managed profile of another user. An admin can become the profile
* owner of a managed profile with {@link #ACTION_PROVISION_MANAGED_PROFILE} and of a managed
* user with {@link #createAndManageUser}
* @param admin Which profile owner this request is associated with.
* @return if this user is a managed profile of another user.
*/
public boolean isManagedProfile(@NonNull ComponentName admin) {
throwIfParentInstance("isManagedProfile");
try {
return mService.isManagedProfile(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Return if this user is a system-only user. An admin can manage a device from a system only
* user by calling {@link #ACTION_PROVISION_MANAGED_SHAREABLE_DEVICE}.
* @param admin Which device owner this request is associated with.
* @return if this user is a system-only user.
*/
public boolean isSystemOnlyUser(@NonNull ComponentName admin) {
try {
return mService.isSystemOnlyUser(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by device owner to get the MAC address of the Wi-Fi device.
*
* @param admin Which device owner this request is associated with.
* @return the MAC address of the Wi-Fi device, or null when the information is not available.
* (For example, Wi-Fi hasn't been enabled, or the device doesn't support Wi-Fi.)
* <p>
* The address will be in the {@code XX:XX:XX:XX:XX:XX} format.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public @Nullable String getWifiMacAddress(@NonNull ComponentName admin) {
throwIfParentInstance("getWifiMacAddress");
try {
return mService.getWifiMacAddress(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by device owner to reboot the device. If there is an ongoing call on the device,
* throws an {@link IllegalStateException}.
* @param admin Which device owner the request is associated with.
* @throws IllegalStateException if device has an ongoing call.
* @throws SecurityException if {@code admin} is not a device owner.
* @see TelephonyManager#CALL_STATE_IDLE
*/
public void reboot(@NonNull ComponentName admin) {
throwIfParentInstance("reboot");
try {
mService.reboot(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device admin to set the short support message. This will be displayed to the user
* in settings screens where funtionality has been disabled by the admin. The message should be
* limited to a short statement such as "This setting is disabled by your administrator. Contact
* someone@example.com for support." If the message is longer than 200 characters it may be
* truncated.
* <p>
* If the short support message needs to be localized, it is the responsibility of the
* {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
* and set a new version of this string accordingly.
*
* @see #setLongSupportMessage
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param message Short message to be displayed to the user in settings or null to clear the
* existing message.
* @throws SecurityException if {@code admin} is not an active administrator.
*/
public void setShortSupportMessage(@NonNull ComponentName admin,
@Nullable CharSequence message) {
throwIfParentInstance("setShortSupportMessage");
if (mService != null) {
try {
mService.setShortSupportMessage(admin, message);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a device admin to get the short support message.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)} or
* null if no message has been set.
* @throws SecurityException if {@code admin} is not an active administrator.
*/
public CharSequence getShortSupportMessage(@NonNull ComponentName admin) {
throwIfParentInstance("getShortSupportMessage");
if (mService != null) {
try {
return mService.getShortSupportMessage(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by a device admin to set the long support message. This will be displayed to the user
* in the device administators settings screen.
* <p>
* If the long support message needs to be localized, it is the responsibility of the
* {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
* and set a new version of this string accordingly.
*
* @see #setShortSupportMessage
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param message Long message to be displayed to the user in settings or null to clear the
* existing message.
* @throws SecurityException if {@code admin} is not an active administrator.
*/
public void setLongSupportMessage(@NonNull ComponentName admin,
@Nullable CharSequence message) {
throwIfParentInstance("setLongSupportMessage");
if (mService != null) {
try {
mService.setLongSupportMessage(admin, message);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by a device admin to get the long support message.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)} or
* null if no message has been set.
* @throws SecurityException if {@code admin} is not an active administrator.
*/
public @Nullable CharSequence getLongSupportMessage(@NonNull ComponentName admin) {
throwIfParentInstance("getLongSupportMessage");
if (mService != null) {
try {
return mService.getLongSupportMessage(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by the system to get the short support message.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param userHandle user id the admin is running as.
* @return The message set by {@link #setShortSupportMessage(ComponentName, CharSequence)}
*
* @hide
*/
public @Nullable CharSequence getShortSupportMessageForUser(@NonNull ComponentName admin,
int userHandle) {
if (mService != null) {
try {
return mService.getShortSupportMessageForUser(admin, userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by the system to get the long support message.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param userHandle user id the admin is running as.
* @return The message set by {@link #setLongSupportMessage(ComponentName, CharSequence)}
*
* @hide
*/
public @Nullable CharSequence getLongSupportMessageForUser(
@NonNull ComponentName admin, int userHandle) {
if (mService != null) {
try {
return mService.getLongSupportMessageForUser(admin, userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return null;
}
/**
* Called by the profile owner of a managed profile to obtain a {@link DevicePolicyManager}
* whose calls act on the parent profile.
*
* <p>The following methods are supported for the parent instance, all other methods will
* throw a SecurityException when called on the parent instance:
* <ul>
* <li>{@link #getPasswordQuality}</li>
* <li>{@link #setPasswordQuality}</li>
* <li>{@link #getPasswordMinimumLength}</li>
* <li>{@link #setPasswordMinimumLength}</li>
* <li>{@link #getPasswordMinimumUpperCase}</li>
* <li>{@link #setPasswordMinimumUpperCase}</li>
* <li>{@link #getPasswordMinimumLowerCase}</li>
* <li>{@link #setPasswordMinimumLowerCase}</li>
* <li>{@link #getPasswordMinimumLetters}</li>
* <li>{@link #setPasswordMinimumLetters}</li>
* <li>{@link #getPasswordMinimumNumeric}</li>
* <li>{@link #setPasswordMinimumNumeric}</li>
* <li>{@link #getPasswordMinimumSymbols}</li>
* <li>{@link #setPasswordMinimumSymbols}</li>
* <li>{@link #getPasswordMinimumNonLetter}</li>
* <li>{@link #setPasswordMinimumNonLetter}</li>
* <li>{@link #getPasswordHistoryLength}</li>
* <li>{@link #setPasswordHistoryLength}</li>
* <li>{@link #getPasswordExpirationTimeout}</li>
* <li>{@link #setPasswordExpirationTimeout}</li>
* <li>{@link #getPasswordExpiration}</li>
* <li>{@link #getPasswordMaximumLength}</li>
* <li>{@link #isActivePasswordSufficient}</li>
* <li>{@link #getCurrentFailedPasswordAttempts}</li>
* <li>{@link #getMaximumFailedPasswordsForWipe}</li>
* <li>{@link #setMaximumFailedPasswordsForWipe}</li>
* <li>{@link #getMaximumTimeToLock}</li>
* <li>{@link #setMaximumTimeToLock}</li>
* <li>{@link #lockNow}</li>
* <li>{@link #getKeyguardDisabledFeatures}</li>
* <li>{@link #setKeyguardDisabledFeatures}</li>
* <li>{@link #getTrustAgentConfiguration}</li>
* <li>{@link #setTrustAgentConfiguration}</li>
* <li>{@link #getRequiredStrongAuthTimeout}</li>
* <li>{@link #setRequiredStrongAuthTimeout}</li>
* </ul>
*
* @return a new instance of {@link DevicePolicyManager} that acts on the parent profile.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public @NonNull DevicePolicyManager getParentProfileInstance(@NonNull ComponentName admin) {
throwIfParentInstance("getParentProfileInstance");
try {
if (!mService.isManagedProfile(admin)) {
throw new SecurityException("The current user does not have a parent profile.");
}
return new DevicePolicyManager(mContext, mService, true);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Called by device owner to control the security logging feature.
*
* <p> Security logs contain various information intended for security auditing purposes.
* See {@link SecurityEvent} for details.
*
* <p><strong>Note:</strong> The device owner won't be able to retrieve security logs if there
* are unaffiliated secondary users or profiles on the device, regardless of whether the
* feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for
* all users to become affiliated. Therefore it's recommended that affiliation ids are set for
* new users as soon as possible after provisioning via {@link #setAffiliationIds}.
*
* @param admin Which device owner this request is associated with.
* @param enabled whether security logging should be enabled or not.
* @throws SecurityException if {@code admin} is not a device owner.
* @see #setAffiliationIds
* @see #retrieveSecurityLogs
*/
public void setSecurityLoggingEnabled(@NonNull ComponentName admin, boolean enabled) {
throwIfParentInstance("setSecurityLoggingEnabled");
try {
mService.setSecurityLoggingEnabled(admin, enabled);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Return whether security logging is enabled or not by the device owner.
*
* <p>Can only be called by the device owner, otherwise a {@link SecurityException} will be
* thrown.
*
* @param admin Which device owner this request is associated with.
* @return {@code true} if security logging is enabled by device owner, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public boolean isSecurityLoggingEnabled(@Nullable ComponentName admin) {
throwIfParentInstance("isSecurityLoggingEnabled");
try {
return mService.isSecurityLoggingEnabled(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by device owner to retrieve all new security logging entries since the last call to
* this API after device boots.
*
* <p> Access to the logs is rate limited and it will only return new logs after the device
* owner has been notified via {@link DeviceAdminReceiver#onSecurityLogsAvailable}.
*
* <p>If there is any other user or profile on the device, it must be affiliated with the
* device. Otherwise a {@link SecurityException} will be thrown. See {@link #isAffiliatedUser}.
*
* @param admin Which device owner this request is associated with.
* @return the new batch of security logs which is a list of {@link SecurityEvent},
* or {@code null} if rate limitation is exceeded or if logging is currently disabled.
* @throws SecurityException if {@code admin} is not a device owner, or there is at least one
* profile or secondary user that is not affiliated with the device.
* @see #isAffiliatedUser
* @see DeviceAdminReceiver#onSecurityLogsAvailable
*/
public @Nullable List<SecurityEvent> retrieveSecurityLogs(@NonNull ComponentName admin) {
throwIfParentInstance("retrieveSecurityLogs");
try {
ParceledListSlice<SecurityEvent> list = mService.retrieveSecurityLogs(admin);
if (list != null) {
return list.getList();
} else {
// Rate limit exceeded.
return null;
}
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Makes all accumulated network logs available to DPC in a new batch.
* Only callable by ADB. If throttled, returns time to wait in milliseconds, otherwise 0.
* @hide
*/
public long forceNetworkLogs() {
if (mService == null) {
return -1;
}
try {
return mService.forceNetworkLogs();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Forces a batch of security logs to be fetched from logd and makes it available for DPC.
* Only callable by ADB. If throttled, returns time to wait in milliseconds, otherwise 0.
* @hide
*/
public long forceSecurityLogs() {
if (mService == null) {
return 0;
}
try {
return mService.forceSecurityLogs();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the system to obtain a {@link DevicePolicyManager} whose calls act on the parent
* profile.
*
* @hide
*/
public @NonNull DevicePolicyManager getParentProfileInstance(UserInfo uInfo) {
mContext.checkSelfPermission(
android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS);
if (!uInfo.isManagedProfile()) {
throw new SecurityException("The user " + uInfo.id
+ " does not have a parent profile.");
}
return new DevicePolicyManager(mContext, mService, true);
}
/**
* Called by a device or profile owner to restrict packages from using metered data.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @param packageNames the list of package names to be restricted.
* @return a list of package names which could not be restricted.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public @NonNull List<String> setMeteredDataDisabledPackages(@NonNull ComponentName admin,
@NonNull List<String> packageNames) {
throwIfParentInstance("setMeteredDataDisabled");
if (mService != null) {
try {
return mService.setMeteredDataDisabledPackages(admin, packageNames);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return packageNames;
}
/**
* Called by a device or profile owner to retrieve the list of packages which are restricted
* by the admin from using metered data.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @return the list of restricted package names.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public @NonNull List<String> getMeteredDataDisabledPackages(@NonNull ComponentName admin) {
throwIfParentInstance("getMeteredDataDisabled");
if (mService != null) {
try {
return mService.getMeteredDataDisabledPackages(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return new ArrayList<>();
}
/**
* Called by the system to check if a package is restricted from using metered data
* by {@param admin}.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName the package whose restricted status is needed.
* @param userId the user to which {@param packageName} belongs.
* @return {@code true} if the package is restricted by admin, otherwise {@code false}
* @throws SecurityException if the caller doesn't run with {@link Process#SYSTEM_UID}
* @hide
*/
public boolean isMeteredDataDisabledPackageForUser(@NonNull ComponentName admin,
String packageName, @UserIdInt int userId) {
throwIfParentInstance("getMeteredDataDisabledForUser");
if (mService != null) {
try {
return mService.isMeteredDataDisabledPackageForUser(admin, packageName, userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by device owners to retrieve device logs from before the device's last reboot.
* <p>
* <strong> This API is not supported on all devices. Calling this API on unsupported devices
* will result in {@code null} being returned. The device logs are retrieved from a RAM region
* which is not guaranteed to be corruption-free during power cycles, as a result be cautious
* about data corruption when parsing. </strong>
*
* <p>If there is any other user or profile on the device, it must be affiliated with the
* device. Otherwise a {@link SecurityException} will be thrown. See {@link #isAffiliatedUser}.
*
* @param admin Which device owner this request is associated with.
* @return Device logs from before the latest reboot of the system, or {@code null} if this API
* is not supported on the device.
* @throws SecurityException if {@code admin} is not a device owner, or there is at least one
* profile or secondary user that is not affiliated with the device.
* @see #isAffiliatedUser
* @see #retrieveSecurityLogs
*/
public @Nullable List<SecurityEvent> retrievePreRebootSecurityLogs(
@NonNull ComponentName admin) {
throwIfParentInstance("retrievePreRebootSecurityLogs");
try {
ParceledListSlice<SecurityEvent> list = mService.retrievePreRebootSecurityLogs(admin);
if (list != null) {
return list.getList();
} else {
return null;
}
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a profile owner of a managed profile to set the color used for customization. This
* color is used as background color of the confirm credentials screen for that user. The
* default color is teal (#00796B).
* <p>
* The confirm credentials screen can be created using
* {@link android.app.KeyguardManager#createConfirmDeviceCredentialIntent}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param color The 24bit (0xRRGGBB) representation of the color to be used.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public void setOrganizationColor(@NonNull ComponentName admin, int color) {
throwIfParentInstance("setOrganizationColor");
try {
// always enforce alpha channel to have 100% opacity
color |= 0xFF000000;
mService.setOrganizationColor(admin, color);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
*
* Sets the color used for customization.
*
* @param color The 24bit (0xRRGGBB) representation of the color to be used.
* @param userId which user to set the color to.
* @RequiresPermission(allOf = {
* Manifest.permission.MANAGE_USERS,
* Manifest.permission.INTERACT_ACROSS_USERS_FULL})
*/
public void setOrganizationColorForUser(@ColorInt int color, @UserIdInt int userId) {
try {
// always enforce alpha channel to have 100% opacity
color |= 0xFF000000;
mService.setOrganizationColorForUser(color, userId);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a profile owner of a managed profile to retrieve the color used for customization.
* This color is used as background color of the confirm credentials screen for that user.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return The 24bit (0xRRGGBB) representation of the color to be used.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public @ColorInt int getOrganizationColor(@NonNull ComponentName admin) {
throwIfParentInstance("getOrganizationColor");
try {
return mService.getOrganizationColor(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Retrieve the customization color for a given user.
*
* @param userHandle The user id of the user we're interested in.
* @return The 24bit (0xRRGGBB) representation of the color to be used.
*/
public @ColorInt int getOrganizationColorForUser(int userHandle) {
try {
return mService.getOrganizationColorForUser(userHandle);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the device owner (since API 26) or profile owner (since API 24) to set the name of
* the organization under management.
*
* <p>If the organization name needs to be localized, it is the responsibility of the {@link
* DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast and set
* a new version of this string accordingly.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param title The organization name or {@code null} to clear a previously set name.
* @throws SecurityException if {@code admin} is not a device or profile owner.
*/
public void setOrganizationName(@NonNull ComponentName admin, @Nullable CharSequence title) {
throwIfParentInstance("setOrganizationName");
try {
mService.setOrganizationName(admin, title);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a profile owner of a managed profile to retrieve the name of the organization under
* management.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @return The organization name or {@code null} if none is set.
* @throws SecurityException if {@code admin} is not a profile owner.
*/
public @Nullable CharSequence getOrganizationName(@NonNull ComponentName admin) {
throwIfParentInstance("getOrganizationName");
try {
return mService.getOrganizationName(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the system to retrieve the name of the organization managing the device.
*
* @return The organization name or {@code null} if none is set.
* @throws SecurityException if the caller is not the device owner, does not hold the
* MANAGE_USERS permission and is not the system.
*
* @hide
*/
@SystemApi
@TestApi
@SuppressLint("Doclava125")
public @Nullable CharSequence getDeviceOwnerOrganizationName() {
try {
return mService.getDeviceOwnerOrganizationName();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Retrieve the default title message used in the confirm credentials screen for a given user.
*
* @param userHandle The user id of the user we're interested in.
* @return The organization name or {@code null} if none is set.
*
* @hide
*/
public @Nullable CharSequence getOrganizationNameForUser(int userHandle) {
try {
return mService.getOrganizationNameForUser(userHandle);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @return the {@link UserProvisioningState} for the current user - for unmanaged users will
* return {@link #STATE_USER_UNMANAGED}
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
@UserProvisioningState
public int getUserProvisioningState() {
throwIfParentInstance("getUserProvisioningState");
if (mService != null) {
try {
return mService.getUserProvisioningState();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return STATE_USER_UNMANAGED;
}
/**
* Set the {@link UserProvisioningState} for the supplied user, if they are managed.
*
* @param state to store
* @param userHandle for user
* @hide
*/
public void setUserProvisioningState(@UserProvisioningState int state, int userHandle) {
if (mService != null) {
try {
mService.setUserProvisioningState(state, userHandle);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Indicates the entity that controls the device or profile owner. Two users/profiles are
* affiliated if the set of ids set by their device or profile owners intersect.
*
* <p>A user/profile that is affiliated with the device owner user is considered to be
* affiliated with the device.
*
* <p><strong>Note:</strong> Features that depend on user affiliation (such as security logging
* or {@link #bindDeviceAdminServiceAsUser}) won't be available when a secondary user or profile
* is created, until it becomes affiliated. Therefore it is recommended that the appropriate
* affiliation ids are set by its profile owner as soon as possible after the user/profile is
* created.
*
* @param admin Which profile or device owner this request is associated with.
* @param ids A set of opaque non-empty affiliation ids.
*
* @throws IllegalArgumentException if {@code ids} is null or contains an empty string.
* @see #isAffiliatedUser
*/
public void setAffiliationIds(@NonNull ComponentName admin, @NonNull Set<String> ids) {
throwIfParentInstance("setAffiliationIds");
if (ids == null) {
throw new IllegalArgumentException("ids must not be null");
}
try {
mService.setAffiliationIds(admin, new ArrayList<>(ids));
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Returns the set of affiliation ids previously set via {@link #setAffiliationIds}, or an
* empty set if none have been set.
*/
public @NonNull Set<String> getAffiliationIds(@NonNull ComponentName admin) {
throwIfParentInstance("getAffiliationIds");
try {
return new ArraySet<>(mService.getAffiliationIds(admin));
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Returns whether this user/profile is affiliated with the device.
* <p>
* By definition, the user that the device owner runs on is always affiliated with the device.
* Any other user/profile is considered affiliated with the device if the set specified by its
* profile owner via {@link #setAffiliationIds} intersects with the device owner's.
* @see #setAffiliationIds
*/
public boolean isAffiliatedUser() {
throwIfParentInstance("isAffiliatedUser");
try {
return mService.isAffiliatedUser();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* @hide
* Returns whether the uninstall for {@code packageName} for the current user is in queue
* to be started
* @param packageName the package to check for
* @return whether the uninstall intent for {@code packageName} is pending
*/
public boolean isUninstallInQueue(String packageName) {
try {
return mService.isUninstallInQueue(packageName);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* @param packageName the package containing active DAs to be uninstalled
*/
public void uninstallPackageWithActiveAdmins(String packageName) {
try {
mService.uninstallPackageWithActiveAdmins(packageName);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Remove a test admin synchronously without sending it a broadcast about being removed.
* If the admin is a profile owner or device owner it will still be removed.
*
* @param userHandle user id to remove the admin for.
* @param admin The administration compononent to remove.
* @throws SecurityException if the caller is not shell / root or the admin package
* isn't a test application see {@link ApplicationInfo#FLAG_TEST_APP}.
*/
public void forceRemoveActiveAdmin(ComponentName adminReceiver, int userHandle) {
try {
mService.forceRemoveActiveAdmin(adminReceiver, userHandle);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether the device has been provisioned.
*
* <p>Not for use by third-party applications.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public boolean isDeviceProvisioned() {
try {
return mService.isDeviceProvisioned();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Writes that the provisioning configuration has been applied.
*
* <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS}
* permission.
*
* <p>Not for use by third-party applications.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public void setDeviceProvisioningConfigApplied() {
try {
mService.setDeviceProvisioningConfigApplied();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether the provisioning configuration has been applied.
*
* <p>The caller must hold the {@link android.Manifest.permission#MANAGE_USERS} permission.
*
* <p>Not for use by third-party applications.
*
* @return whether the provisioning configuration has been applied.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public boolean isDeviceProvisioningConfigApplied() {
try {
return mService.isDeviceProvisioningConfigApplied();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* @hide
* Force update user setup completed status. This API has no effect on user build.
* @throws {@link SecurityException} if the caller has no
* {@code android.Manifest.permission.MANAGE_PROFILE_AND_DEVICE_OWNERS} or the caller is
* not {@link UserHandle#SYSTEM_USER}
*/
public void forceUpdateUserSetupComplete() {
try {
mService.forceUpdateUserSetupComplete();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
@UnsupportedAppUsage
private void throwIfParentInstance(String functionName) {
if (mParentInstance) {
throw new SecurityException(functionName + " cannot be called on the parent instance");
}
}
/**
* Allows the device owner or profile owner to enable or disable the backup service.
*
* <p> Each user has its own backup service which manages the backup and restore mechanisms in
* that user. Disabling the backup service will prevent data from being backed up or restored.
*
* <p> Device owner calls this API to control backup services across all users on the device.
* Profile owner can use this API to enable or disable the profile's backup service. However,
* for a managed profile its backup functionality is only enabled if both the device owner
* and the profile owner have enabled the backup service.
*
* <p> By default, backup service is disabled on a device with device owner, and within a
* managed profile.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param enabled {@code true} to enable the backup service, {@code false} to disable it.
* @throws SecurityException if {@code admin} is not a device owner or a profile owner.
*/
public void setBackupServiceEnabled(@NonNull ComponentName admin, boolean enabled) {
throwIfParentInstance("setBackupServiceEnabled");
try {
mService.setBackupServiceEnabled(admin, enabled);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Return whether the backup service is enabled by the device owner or profile owner for the
* current user, as previously set by {@link #setBackupServiceEnabled(ComponentName, boolean)}.
*
* <p> Whether the backup functionality is actually enabled or not depends on settings from both
* the current user and the device owner, please see
* {@link #setBackupServiceEnabled(ComponentName, boolean)} for details.
*
* <p> Backup service manages all backup and restore mechanisms on the device.
*
* @return {@code true} if backup service is enabled, {@code false} otherwise.
* @see #setBackupServiceEnabled
*/
public boolean isBackupServiceEnabled(@NonNull ComponentName admin) {
throwIfParentInstance("isBackupServiceEnabled");
try {
return mService.isBackupServiceEnabled(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner or delegated app with {@link #DELEGATION_NETWORK_LOGGING} to
* control the network logging feature.
*
* <p> Network logs contain DNS lookup and connect() library call events. The following library
* functions are recorded while network logging is active:
* <ul>
* <li>{@code getaddrinfo()}</li>
* <li>{@code gethostbyname()}</li>
* <li>{@code connect()}</li>
* </ul>
*
* <p> Network logging is a low-overhead tool for forensics but it is not guaranteed to use
* full system call logging; event reporting is enabled by default for all processes but not
* strongly enforced.
* Events from applications using alternative implementations of libc, making direct kernel
* calls, or deliberately obfuscating traffic may not be recorded.
*
* <p> Some common network events may not be reported. For example:
* <ul>
* <li>Applications may hardcode IP addresses to reduce the number of DNS lookups, or use
* an alternative system for name resolution, and so avoid calling
* {@code getaddrinfo()} or {@code gethostbyname}.</li>
* <li>Applications may use datagram sockets for performance reasons, for example
* for a game client. Calling {@code connect()} is unnecessary for this kind of
* socket, so it will not trigger a network event.</li>
* </ul>
*
* <p> It is possible to directly intercept layer 3 traffic leaving the device using an
* always-on VPN service.
* See {@link #setAlwaysOnVpnPackage(ComponentName, String, boolean)}
* and {@link android.net.VpnService} for details.
*
* <p><strong>Note:</strong> The device owner won't be able to retrieve network logs if there
* are unaffiliated secondary users or profiles on the device, regardless of whether the
* feature is enabled. Logs will be discarded if the internal buffer fills up while waiting for
* all users to become affiliated. Therefore it's recommended that affiliation ids are set for
* new users as soon as possible after provisioning via {@link #setAffiliationIds}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if called by a delegated app.
* @param enabled whether network logging should be enabled or not.
* @throws SecurityException if {@code admin} is not a device owner.
* @see #setAffiliationIds
* @see #retrieveNetworkLogs
*/
public void setNetworkLoggingEnabled(@Nullable ComponentName admin, boolean enabled) {
throwIfParentInstance("setNetworkLoggingEnabled");
try {
mService.setNetworkLoggingEnabled(admin, mContext.getPackageName(), enabled);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Return whether network logging is enabled by a device owner.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with. Can only
* be {@code null} if the caller is a delegated app with {@link #DELEGATION_NETWORK_LOGGING}
* or has MANAGE_USERS permission.
* @return {@code true} if network logging is enabled by device owner, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not a device owner and caller has
* no MANAGE_USERS permission
*/
public boolean isNetworkLoggingEnabled(@Nullable ComponentName admin) {
throwIfParentInstance("isNetworkLoggingEnabled");
try {
return mService.isNetworkLoggingEnabled(admin, mContext.getPackageName());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by device owner or delegated app with {@link #DELEGATION_NETWORK_LOGGING} to retrieve
* the most recent batch of network logging events.
* A device owner has to provide a batchToken provided as part of
* {@link DeviceAdminReceiver#onNetworkLogsAvailable} callback. If the token doesn't match the
* token of the most recent available batch of logs, {@code null} will be returned.
*
* <p> {@link NetworkEvent} can be one of {@link DnsEvent} or {@link ConnectEvent}.
*
* <p> The list of network events is sorted chronologically, and contains at most 1200 events.
*
* <p> Access to the logs is rate limited and this method will only return a new batch of logs
* after the device device owner has been notified via
* {@link DeviceAdminReceiver#onNetworkLogsAvailable}.
*
* <p>If a secondary user or profile is created, calling this method will throw a
* {@link SecurityException} until all users become affiliated again. It will also no longer be
* possible to retrieve the network logs batch with the most recent batchToken provided
* by {@link DeviceAdminReceiver#onNetworkLogsAvailable}. See
* {@link DevicePolicyManager#setAffiliationIds}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with, or
* {@code null} if called by a delegated app.
* @param batchToken A token of the batch to retrieve
* @return A new batch of network logs which is a list of {@link NetworkEvent}. Returns
* {@code null} if the batch represented by batchToken is no longer available or if
* logging is disabled.
* @throws SecurityException if {@code admin} is not a device owner, or there is at least one
* profile or secondary user that is not affiliated with the device.
* @see #setAffiliationIds
* @see DeviceAdminReceiver#onNetworkLogsAvailable
*/
public @Nullable List<NetworkEvent> retrieveNetworkLogs(@Nullable ComponentName admin,
long batchToken) {
throwIfParentInstance("retrieveNetworkLogs");
try {
return mService.retrieveNetworkLogs(admin, mContext.getPackageName(), batchToken);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner to bind to a service from a profile owner or vice versa.
* See {@link #getBindDeviceAdminTargetUsers} for a definition of which
* device/profile owners are allowed to bind to services of another profile/device owner.
* <p>
* The service must be protected by {@link android.Manifest.permission#BIND_DEVICE_ADMIN}.
* Note that the {@link Context} used to obtain this
* {@link DevicePolicyManager} instance via {@link Context#getSystemService(Class)} will be used
* to bind to the {@link android.app.Service}.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param serviceIntent Identifies the service to connect to. The Intent must specify either an
* explicit component name or a package name to match an
* {@link IntentFilter} published by a service.
* @param conn Receives information as the service is started and stopped in main thread. This
* must be a valid {@link ServiceConnection} object; it must not be {@code null}.
* @param flags Operation options for the binding operation. See
* {@link Context#bindService(Intent, ServiceConnection, int)}.
* @param targetUser Which user to bind to. Must be one of the users returned by
* {@link #getBindDeviceAdminTargetUsers}, otherwise a {@link SecurityException} will
* be thrown.
* @return If you have successfully bound to the service, {@code true} is returned;
* {@code false} is returned if the connection is not made and you will not
* receive the service object.
*
* @see Context#bindService(Intent, ServiceConnection, int)
* @see #getBindDeviceAdminTargetUsers(ComponentName)
*/
public boolean bindDeviceAdminServiceAsUser(
@NonNull ComponentName admin, Intent serviceIntent, @NonNull ServiceConnection conn,
@Context.BindServiceFlags int flags, @NonNull UserHandle targetUser) {
throwIfParentInstance("bindDeviceAdminServiceAsUser");
// Keep this in sync with ContextImpl.bindServiceCommon.
try {
final IServiceConnection sd = mContext.getServiceDispatcher(
conn, mContext.getMainThreadHandler(), flags);
serviceIntent.prepareToLeaveProcess(mContext);
return mService.bindDeviceAdminServiceAsUser(admin,
mContext.getIApplicationThread(), mContext.getActivityToken(), serviceIntent,
sd, flags, targetUser.getIdentifier());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the list of target users that the calling device or profile owner can use when
* calling {@link #bindDeviceAdminServiceAsUser}.
* <p>
* A device owner can bind to a service from a profile owner and vice versa, provided that:
* <ul>
* <li>Both belong to the same package name.
* <li>Both users are affiliated. See {@link #setAffiliationIds}.
* </ul>
*/
public @NonNull List<UserHandle> getBindDeviceAdminTargetUsers(@NonNull ComponentName admin) {
throwIfParentInstance("getBindDeviceAdminTargetUsers");
try {
return mService.getBindDeviceAdminTargetUsers(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the system to get the time at which the device owner last retrieved security
* logging entries.
*
* @return the time at which the device owner most recently retrieved security logging entries,
* in milliseconds since epoch; -1 if security logging entries were never retrieved.
* @throws SecurityException if the caller is not the device owner, does not hold the
* MANAGE_USERS permission and is not the system.
*
* @hide
*/
@TestApi
public long getLastSecurityLogRetrievalTime() {
try {
return mService.getLastSecurityLogRetrievalTime();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the system to get the time at which the device owner last requested a bug report.
*
* @return the time at which the device owner most recently requested a bug report, in
* milliseconds since epoch; -1 if a bug report was never requested.
* @throws SecurityException if the caller is not the device owner, does not hold the
* MANAGE_USERS permission and is not the system.
*
* @hide
*/
@TestApi
public long getLastBugReportRequestTime() {
try {
return mService.getLastBugReportRequestTime();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the system to get the time at which the device owner last retrieved network logging
* events.
*
* @return the time at which the device owner most recently retrieved network logging events, in
* milliseconds since epoch; -1 if network logging events were never retrieved.
* @throws SecurityException if the caller is not the device owner, does not hold the
* MANAGE_USERS permission and is not the system.
*
* @hide
*/
@TestApi
public long getLastNetworkLogRetrievalTime() {
try {
return mService.getLastNetworkLogRetrievalTime();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the system to find out whether the current user's IME was set by the device/profile
* owner or the user.
*
* @return {@code true} if the user's IME was set by the device or profile owner, {@code false}
* otherwise.
* @throws SecurityException if the caller is not the device owner/profile owner.
*
* @hide
*/
@TestApi
public boolean isCurrentInputMethodSetByOwner() {
try {
return mService.isCurrentInputMethodSetByOwner();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the system to get a list of CA certificates that were installed by the device or
* profile owner.
*
* <p> The caller must be the target user's device owner/profile Owner or hold the
* {@link android.Manifest.permission#INTERACT_ACROSS_USERS_FULL} permission.
*
* @param user The user for whom to retrieve information.
* @return list of aliases identifying CA certificates installed by the device or profile owner
* @throws SecurityException if the caller does not have permission to retrieve information
* about the given user's CA certificates.
*
* @hide
*/
@TestApi
public List<String> getOwnerInstalledCaCerts(@NonNull UserHandle user) {
try {
return mService.getOwnerInstalledCaCerts(user).getList();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by the device owner or profile owner to clear application user data of a given
* package. The behaviour of this is equivalent to the target application calling
* {@link android.app.ActivityManager#clearApplicationUserData()}.
*
* <p><strong>Note:</strong> an application can store data outside of its application data, e.g.
* external storage or user dictionary. This data will not be wiped by calling this API.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param packageName The name of the package which will have its user data wiped.
* @param executor The executor through which the listener should be invoked.
* @param listener A callback object that will inform the caller when the clearing is done.
* @throws SecurityException if the caller is not the device owner/profile owner.
*/
public void clearApplicationUserData(@NonNull ComponentName admin,
@NonNull String packageName, @NonNull @CallbackExecutor Executor executor,
@NonNull OnClearApplicationUserDataListener listener) {
throwIfParentInstance("clearAppData");
Preconditions.checkNotNull(executor);
Preconditions.checkNotNull(listener);
try {
mService.clearApplicationUserData(admin, packageName,
new IPackageDataObserver.Stub() {
public void onRemoveCompleted(String pkg, boolean succeeded) {
executor.execute(() ->
listener.onApplicationUserDataCleared(pkg, succeeded));
}
});
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner to specify whether logout is enabled for all secondary users. The
* system may show a logout button that stops the user and switches back to the primary user.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param enabled whether logout should be enabled or not.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public void setLogoutEnabled(@NonNull ComponentName admin, boolean enabled) {
throwIfParentInstance("setLogoutEnabled");
try {
mService.setLogoutEnabled(admin, enabled);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns whether logout is enabled by a device owner.
*
* @return {@code true} if logout is enabled by device owner, {@code false} otherwise.
*/
public boolean isLogoutEnabled() {
throwIfParentInstance("isLogoutEnabled");
try {
return mService.isLogoutEnabled();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Callback used in {@link #clearApplicationUserData}
* to indicate that the clearing of an application's user data is done.
*/
public interface OnClearApplicationUserDataListener {
/**
* Method invoked when clearing the application user data has completed.
*
* @param packageName The name of the package which had its user data cleared.
* @param succeeded Whether the clearing succeeded. Clearing fails for device administrator
* apps and protected system packages.
*/
void onApplicationUserDataCleared(String packageName, boolean succeeded);
}
/**
* Returns set of system apps that should be removed during provisioning.
*
* @param admin Which {@link DeviceAdminReceiver} this request is associated with.
* @param userId ID of the user to be provisioned.
* @param provisioningAction action indicating type of provisioning, should be one of
* {@link #ACTION_PROVISION_MANAGED_DEVICE}, {@link #ACTION_PROVISION_MANAGED_PROFILE} or
* {@link #ACTION_PROVISION_MANAGED_USER}.
*
* @hide
*/
public Set<String> getDisallowedSystemApps(ComponentName admin, int userId,
String provisioningAction) {
try {
return new ArraySet<>(
mService.getDisallowedSystemApps(admin, userId, provisioningAction));
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Changes the current administrator to another one. All policies from the current
* administrator are migrated to the new administrator. The whole operation is atomic -
* the transfer is either complete or not done at all.
*
* <p>Depending on the current administrator (device owner, profile owner), you have the
* following expected behaviour:
* <ul>
* <li>A device owner can only be transferred to a new device owner</li>
* <li>A profile owner can only be transferred to a new profile owner</li>
* </ul>
*
* <p>Use the {@code bundle} parameter to pass data to the new administrator. The data
* will be received in the
* {@link DeviceAdminReceiver#onTransferOwnershipComplete(Context, PersistableBundle)}
* callback of the new administrator.
*
* <p>The transfer has failed if the original administrator is still the corresponding owner
* after calling this method.
*
* <p>The incoming target administrator must have the
* <code><support-transfer-ownership /></code> tag inside the
* <code><device-admin></device-admin></code> tags in the xml file referenced by
* {@link DeviceAdminReceiver#DEVICE_ADMIN_META_DATA}. Otherwise an
* {@link IllegalArgumentException} will be thrown.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with
* @param target which {@link DeviceAdminReceiver} we want the new administrator to be
* @param bundle data to be sent to the new administrator
* @throws SecurityException if {@code admin} is not a device owner nor a profile owner
* @throws IllegalArgumentException if {@code admin} or {@code target} is {@code null}, they
* are components in the same package or {@code target} is not an active admin
*/
public void transferOwnership(@NonNull ComponentName admin, @NonNull ComponentName target,
@Nullable PersistableBundle bundle) {
throwIfParentInstance("transferOwnership");
try {
mService.transferOwnership(admin, target, bundle);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner to specify the user session start message. This may be displayed
* during a user switch.
* <p>
* The message should be limited to a short statement or it may be truncated.
* <p>
* If the message needs to be localized, it is the responsibility of the
* {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
* and set a new version of this message accordingly.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @param startUserSessionMessage message for starting user session, or {@code null} to use
* system default message.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public void setStartUserSessionMessage(
@NonNull ComponentName admin, @Nullable CharSequence startUserSessionMessage) {
throwIfParentInstance("setStartUserSessionMessage");
try {
mService.setStartUserSessionMessage(admin, startUserSessionMessage);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by a device owner to specify the user session end message. This may be displayed
* during a user switch.
* <p>
* The message should be limited to a short statement or it may be truncated.
* <p>
* If the message needs to be localized, it is the responsibility of the
* {@link DeviceAdminReceiver} to listen to the {@link Intent#ACTION_LOCALE_CHANGED} broadcast
* and set a new version of this message accordingly.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @param endUserSessionMessage message for ending user session, or {@code null} to use system
* default message.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public void setEndUserSessionMessage(
@NonNull ComponentName admin, @Nullable CharSequence endUserSessionMessage) {
throwIfParentInstance("setEndUserSessionMessage");
try {
mService.setEndUserSessionMessage(admin, endUserSessionMessage);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the user session start message.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public CharSequence getStartUserSessionMessage(@NonNull ComponentName admin) {
throwIfParentInstance("getStartUserSessionMessage");
try {
return mService.getStartUserSessionMessage(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the user session end message.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @throws SecurityException if {@code admin} is not a device owner.
*/
public CharSequence getEndUserSessionMessage(@NonNull ComponentName admin) {
throwIfParentInstance("getEndUserSessionMessage");
try {
return mService.getEndUserSessionMessage(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by device owner to add an override APN.
*
* <p>This method may returns {@code -1} if {@code apnSetting} conflicts with an existing
* override APN. Update the existing conflicted APN with
* {@link #updateOverrideApn(ComponentName, int, ApnSetting)} instead of adding a new entry.
* <p>Two override APNs are considered to conflict when all the following APIs return
* the same values on both override APNs:
* <ul>
* <li>{@link ApnSetting#getOperatorNumeric()}</li>
* <li>{@link ApnSetting#getApnName()}</li>
* <li>{@link ApnSetting#getProxyAddressAsString()}</li>
* <li>{@link ApnSetting#getProxyPort()}</li>
* <li>{@link ApnSetting#getMmsProxyAddressAsString()}</li>
* <li>{@link ApnSetting#getMmsProxyPort()}</li>
* <li>{@link ApnSetting#getMmsc()}</li>
* <li>{@link ApnSetting#isEnabled()}</li>
* <li>{@link ApnSetting#getMvnoType()}</li>
* <li>{@link ApnSetting#getProtocol()}</li>
* <li>{@link ApnSetting#getRoamingProtocol()}</li>
* </ul>
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with
* @param apnSetting the override APN to insert
* @return The {@code id} of inserted override APN. Or {@code -1} when failed to insert into
* the database.
* @throws SecurityException if {@code admin} is not a device owner.
*
* @see #setOverrideApnsEnabled(ComponentName, boolean)
*/
public int addOverrideApn(@NonNull ComponentName admin, @NonNull ApnSetting apnSetting) {
throwIfParentInstance("addOverrideApn");
if (mService != null) {
try {
return mService.addOverrideApn(admin, apnSetting);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return -1;
}
/**
* Called by device owner to update an override APN.
*
* <p>This method may returns {@code false} if there is no override APN with the given
* {@code apnId}.
* <p>This method may also returns {@code false} if {@code apnSetting} conflicts with an
* existing override APN. Update the existing conflicted APN instead.
* <p>See {@link #addOverrideApn} for the definition of conflict.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with
* @param apnId the {@code id} of the override APN to update
* @param apnSetting the override APN to update
* @return {@code true} if the required override APN is successfully updated,
* {@code false} otherwise.
* @throws SecurityException if {@code admin} is not a device owner.
*
* @see #setOverrideApnsEnabled(ComponentName, boolean)
*/
public boolean updateOverrideApn(@NonNull ComponentName admin, int apnId,
@NonNull ApnSetting apnSetting) {
throwIfParentInstance("updateOverrideApn");
if (mService != null) {
try {
return mService.updateOverrideApn(admin, apnId, apnSetting);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by device owner to remove an override APN.
*
* <p>This method may returns {@code false} if there is no override APN with the given
* {@code apnId}.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with
* @param apnId the {@code id} of the override APN to remove
* @return {@code true} if the required override APN is successfully removed, {@code false}
* otherwise.
* @throws SecurityException if {@code admin} is not a device owner.
*
* @see #setOverrideApnsEnabled(ComponentName, boolean)
*/
public boolean removeOverrideApn(@NonNull ComponentName admin, int apnId) {
throwIfParentInstance("removeOverrideApn");
if (mService != null) {
try {
return mService.removeOverrideApn(admin, apnId);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Called by device owner to get all override APNs inserted by device owner.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with
* @return A list of override APNs inserted by device owner.
* @throws SecurityException if {@code admin} is not a device owner.
*
* @see #setOverrideApnsEnabled(ComponentName, boolean)
*/
public List<ApnSetting> getOverrideApns(@NonNull ComponentName admin) {
throwIfParentInstance("getOverrideApns");
if (mService != null) {
try {
return mService.getOverrideApns(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return Collections.emptyList();
}
/**
* Called by device owner to set if override APNs should be enabled.
* <p> Override APNs are separated from other APNs on the device, and can only be inserted or
* modified by the device owner. When enabled, only override APNs are in use, any other APNs
* are ignored.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with
* @param enabled {@code true} if override APNs should be enabled, {@code false} otherwise
* @throws SecurityException if {@code admin} is not a device owner.
*/
public void setOverrideApnsEnabled(@NonNull ComponentName admin, boolean enabled) {
throwIfParentInstance("setOverrideApnEnabled");
if (mService != null) {
try {
mService.setOverrideApnsEnabled(admin, enabled);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Called by device owner to check if override APNs are currently enabled.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with
* @return {@code true} if override APNs are currently enabled, {@code false} otherwise.
* @throws SecurityException if {@code admin} is not a device owner.
*
* @see #setOverrideApnsEnabled(ComponentName, boolean)
*/
public boolean isOverrideApnEnabled(@NonNull ComponentName admin) {
throwIfParentInstance("isOverrideApnEnabled");
if (mService != null) {
try {
return mService.isOverrideApnEnabled(admin);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Returns the data passed from the current administrator to the new administrator during an
* ownership transfer. This is the same {@code bundle} passed in
* {@link #transferOwnership(ComponentName, ComponentName, PersistableBundle)}. The bundle is
* persisted until the profile owner or device owner is removed.
*
* <p>This is the same <code>bundle</code> received in the
* {@link DeviceAdminReceiver#onTransferOwnershipComplete(Context, PersistableBundle)}.
* Use this method to retrieve it after the transfer as long as the new administrator is the
* active device or profile owner.
*
* <p>Returns <code>null</code> if no ownership transfer was started for the calling user.
*
* @see #transferOwnership
* @see DeviceAdminReceiver#onTransferOwnershipComplete(Context, PersistableBundle)
* @throws SecurityException if the caller is not a device or profile owner.
*/
@Nullable
public PersistableBundle getTransferOwnershipBundle() {
throwIfParentInstance("getTransferOwnershipBundle");
try {
return mService.getTransferOwnershipBundle();
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Sets the global Private DNS mode to opportunistic.
* May only be called by the device owner.
*
* <p>In this mode, the DNS subsystem will attempt a TLS handshake to the network-supplied
* resolver prior to attempting name resolution in cleartext.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
*
* @return {@code PRIVATE_DNS_SET_NO_ERROR} if the mode was set successfully, or
* {@code PRIVATE_DNS_SET_ERROR_FAILURE_SETTING} if it could not be set.
*
* @throws SecurityException if the caller is not the device owner.
*/
public @PrivateDnsModeErrorCodes int setGlobalPrivateDnsModeOpportunistic(
@NonNull ComponentName admin) {
throwIfParentInstance("setGlobalPrivateDnsModeOpportunistic");
if (mService == null) {
return PRIVATE_DNS_SET_ERROR_FAILURE_SETTING;
}
try {
return mService.setGlobalPrivateDns(admin, PRIVATE_DNS_MODE_OPPORTUNISTIC, null);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Sets the global Private DNS host to be used.
* May only be called by the device owner.
*
* <p>Note that the method is blocking as it will perform a connectivity check to the resolver,
* to ensure it is valid. Because of that, the method should not be called on any thread that
* relates to user interaction, such as the UI thread.
*
* <p>In case a VPN is used in conjunction with Private DNS resolver, the Private DNS resolver
* must be reachable both from within and outside the VPN. Otherwise, the device may lose
* the ability to resolve hostnames as system traffic to the resolver may not go through the
* VPN.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @param privateDnsHost The hostname of a server that implements DNS over TLS (RFC7858).
*
* @return {@code PRIVATE_DNS_SET_NO_ERROR} if the mode was set successfully,
* {@code PRIVATE_DNS_SET_ERROR_FAILURE_SETTING} if it could not be set or
* {@code PRIVATE_DNS_SET_ERROR_HOST_NOT_SERVING} if the specified host does not
* implement RFC7858.
*
* @throws IllegalArgumentException if the {@code privateDnsHost} is not a valid hostname.
*
* @throws SecurityException if the caller is not the device owner.
*/
@WorkerThread public @PrivateDnsModeErrorCodes int setGlobalPrivateDnsModeSpecifiedHost(
@NonNull ComponentName admin, @NonNull String privateDnsHost) {
throwIfParentInstance("setGlobalPrivateDnsModeSpecifiedHost");
Preconditions.checkNotNull(privateDnsHost, "dns resolver is null");
if (mService == null) {
return PRIVATE_DNS_SET_ERROR_FAILURE_SETTING;
}
if (NetworkUtils.isWeaklyValidatedHostname(privateDnsHost)) {
if (!PrivateDnsConnectivityChecker.canConnectToPrivateDnsServer(privateDnsHost)) {
return PRIVATE_DNS_SET_ERROR_HOST_NOT_SERVING;
}
}
try {
return mService.setGlobalPrivateDns(
admin, PRIVATE_DNS_MODE_PROVIDER_HOSTNAME, privateDnsHost);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Called by device owner to install a system update from the given file. The device will be
* rebooted in order to finish installing the update. Note that if the device is rebooted, this
* doesn't necessarily mean that the update has been applied successfully. The caller should
* additionally check the system version with {@link android.os.Build#FINGERPRINT} or {@link
* android.os.Build.VERSION}. If an error occurs during processing the OTA before the reboot,
* the caller will be notified by {@link InstallSystemUpdateCallback}. If device does not have
* sufficient battery level, the installation will fail with error {@link
* InstallSystemUpdateCallback#UPDATE_ERROR_BATTERY_LOW}.
*
* @param admin The {@link DeviceAdminReceiver} that this request is associated with.
* @param updateFilePath An Uri of the file that contains the update. The file should be
* readable by the calling app.
* @param executor The executor through which the callback should be invoked.
* @param callback A callback object that will inform the caller when installing an update
* fails.
*/
public void installSystemUpdate(
@NonNull ComponentName admin, @NonNull Uri updateFilePath,
@NonNull @CallbackExecutor Executor executor,
@NonNull InstallSystemUpdateCallback callback) {
throwIfParentInstance("installUpdate");
if (mService == null) {
return;
}
try (ParcelFileDescriptor fileDescriptor = mContext.getContentResolver()
.openFileDescriptor(updateFilePath, "r")) {
mService.installUpdateFromFile(
admin, fileDescriptor, new StartInstallingUpdateCallback.Stub() {
@Override
public void onStartInstallingUpdateError(
int errorCode, String errorMessage) {
executeCallback(errorCode, errorMessage, executor, callback);
}
});
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
} catch (FileNotFoundException e) {
Log.w(TAG, e);
executeCallback(
InstallSystemUpdateCallback.UPDATE_ERROR_FILE_NOT_FOUND,
Log.getStackTraceString(e),
executor, callback);
} catch (IOException e) {
Log.w(TAG, e);
executeCallback(
InstallSystemUpdateCallback.UPDATE_ERROR_UNKNOWN, Log.getStackTraceString(e),
executor, callback);
}
}
private void executeCallback(int errorCode, String errorMessage,
@NonNull @CallbackExecutor Executor executor,
@NonNull InstallSystemUpdateCallback callback) {
executor.execute(() -> callback.onInstallUpdateError(errorCode, errorMessage));
}
/**
* Returns the system-wide Private DNS mode.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @return one of {@code PRIVATE_DNS_MODE_OFF}, {@code PRIVATE_DNS_MODE_OPPORTUNISTIC},
* {@code PRIVATE_DNS_MODE_PROVIDER_HOSTNAME} or {@code PRIVATE_DNS_MODE_UNKNOWN}.
* @throws SecurityException if the caller is not the device owner.
*/
public int getGlobalPrivateDnsMode(@NonNull ComponentName admin) {
throwIfParentInstance("setGlobalPrivateDns");
if (mService == null) {
return PRIVATE_DNS_MODE_UNKNOWN;
}
try {
return mService.getGlobalPrivateDnsMode(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Returns the system-wide Private DNS host.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with.
* @return The hostname used for Private DNS queries, null if none is set.
* @throws SecurityException if the caller is not the device owner.
*/
public @Nullable String getGlobalPrivateDnsHost(@NonNull ComponentName admin) {
throwIfParentInstance("setGlobalPrivateDns");
if (mService == null) {
return null;
}
try {
return mService.getGlobalPrivateDnsHost(admin);
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Grants the profile owner of the given user access to device identifiers (such as
* serial number, IMEI and MEID).
*
* <p>This lets the profile owner request inclusion of device identifiers when calling
* {@link generateKeyPair}.
*
* <p>This grant is necessary to guarantee that profile owners can access device identifiers.
*
* <p>Privileged system API - meant to be called by the system, particularly the managed
* provisioning app, when a work profile is set up.
*
* @hide
*/
@SystemApi
@RequiresPermission(value = android.Manifest.permission.GRANT_PROFILE_OWNER_DEVICE_IDS_ACCESS,
conditional = true)
public void setProfileOwnerCanAccessDeviceIds(@NonNull ComponentName who) {
if (mService == null) {
return;
}
try {
mService.grantDeviceIdsAccessToProfileOwner(who, myUserId());
} catch (RemoteException re) {
throw re.rethrowFromSystemServer();
}
}
/**
* Allows a set of packages to access cross-profile calendar APIs.
*
* <p>Called by a profile owner of a managed profile.
*
* <p>Calling with a {@code null} value for the set disables the restriction so that all
* packages are allowed to access cross-profile calendar APIs. Calling with an empty set
* disallows all packages from accessing cross-profile calendar APIs. If this method isn't
* called, no package is allowed to access cross-profile calendar APIs by default.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with
* @param packageNames set of packages to be whitelisted
* @throws SecurityException if {@code admin} is not a profile owner
*
* @see #getCrossProfileCalendarPackages(ComponentName)
*/
public void setCrossProfileCalendarPackages(@NonNull ComponentName admin,
@Nullable Set<String> packageNames) {
throwIfParentInstance("setCrossProfileCalendarPackages");
if (mService != null) {
try {
mService.setCrossProfileCalendarPackages(admin, packageNames == null ? null
: new ArrayList<>(packageNames));
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
/**
* Gets a set of package names that are allowed to access cross-profile calendar APIs.
*
* <p>Called by a profile owner of a managed profile.
*
* @param admin which {@link DeviceAdminReceiver} this request is associated with
* @return the set of names of packages that were previously allowed via
* {@link #setCrossProfileCalendarPackages(ComponentName, Set)}, or an
* empty set if none have been allowed
* @throws SecurityException if {@code admin} is not a profile owner
*
* @see #setCrossProfileCalendarPackages(ComponentName, Set)
*/
public @Nullable Set<String> getCrossProfileCalendarPackages(@NonNull ComponentName admin) {
throwIfParentInstance("getCrossProfileCalendarPackages");
if (mService != null) {
try {
final List<String> packageNames = mService.getCrossProfileCalendarPackages(admin);
return packageNames == null ? null : new ArraySet<>(packageNames);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return Collections.emptySet();
}
/**
* Returns if a package is allowed to access cross-profile calendar APIs.
*
* <p>A package is allowed to access cross-profile calendar APIs if it's allowed by
* admins via {@link #setCrossProfileCalendarPackages(ComponentName, Set)} and
* {@link android.provider.Settings.Secure#CROSS_PROFILE_CALENDAR_ENABLED}
* is turned on in the managed profile.
*
* <p>To query for a specific user, use
* {@link Context#createPackageContextAsUser(String, int, UserHandle)} to create a context for
* that user, and get a {@link DevicePolicyManager} from this context.
*
* @param packageName the name of the package
* @return {@code true} if the package is allowed to access cross-profile calendar APIs,
* {@code false} otherwise
*
* @see #setCrossProfileCalendarPackages(ComponentName, Set)
* @see #getCrossProfileCalendarPackages(ComponentName)
* @hide
*/
public boolean isPackageAllowedToAccessCalendar(@NonNull String packageName) {
throwIfParentInstance("isPackageAllowedToAccessCalendar");
if (mService != null) {
try {
return mService.isPackageAllowedToAccessCalendarForUser(packageName,
myUserId());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Gets a set of package names that are allowed to access cross-profile calendar APIs.
*
* <p>To query for a specific user, use
* {@link Context#createPackageContextAsUser(String, int, UserHandle)} to create a context for
* that user, and get a {@link DevicePolicyManager} from this context.
*
* @return the set of names of packages that were previously allowed via
* {@link #setCrossProfileCalendarPackages(ComponentName, Set)}, or an
* empty set if none have been allowed
*
* @see #setCrossProfileCalendarPackages(ComponentName, Set)
* @see #getCrossProfileCalendarPackages(ComponentName)
* @hide
*/
public @Nullable Set<String> getCrossProfileCalendarPackages() {
throwIfParentInstance("getCrossProfileCalendarPackages");
if (mService != null) {
try {
final List<String> packageNames = mService.getCrossProfileCalendarPackagesForUser(
myUserId());
return packageNames == null ? null : new ArraySet<>(packageNames);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return Collections.emptySet();
}
/**
* Returns whether the device is being used as a managed kiosk. These requirements are as
* follows:
* <ul>
* <li>The device is in Lock Task (therefore there is also a Device Owner app on the
* device)</li>
* <li>The Lock Task feature {@link DevicePolicyManager#LOCK_TASK_FEATURE_SYSTEM_INFO} is
* not enabled, so the system info in the status bar is not visible</li>
* <li>The device does not have a secure lock screen (e.g. it has no lock screen or has
* swipe-to-unlock)</li>
* <li>The device is not in the middle of an ephemeral user session</li>
* </ul>
*
* <p>Publicly-accessible dedicated devices don't have the same privacy model as
* personally-used devices. In particular, user consent popups don't make sense as a barrier to
* accessing persistent data on these devices since the user giving consent and the user whose
* data is on the device are unlikely to be the same. These consent popups prevent the true
* remote management of these devices.
*
* <p>This condition is not sufficient to cover APIs that would access data that only lives for
* the duration of the user's session, since the user has an expectation of privacy in these
* conditions that more closely resembles use of a personal device. In those cases, see {@link
* #isUnattendedManagedKiosk()}.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public boolean isManagedKiosk() {
throwIfParentInstance("isManagedKiosk");
if (mService != null) {
try {
return mService.isManagedKiosk();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Returns whether the device is being used as an unattended managed kiosk. These requirements
* are as follows:
* <ul>
* <li>The device is being used as a managed kiosk, as defined at {@link
* #isManagedKiosk()}</li>
* <li>The device has not received user input for at least 30 minutes</li>
* </ul>
*
* <p>See {@link #isManagedKiosk()} for context. This is a stronger requirement that also
* ensures that the device hasn't been interacted with recently, making it an appropriate check
* for privacy-sensitive APIs that wouldn't be appropriate during an active user session.
*
* @hide
*/
@SystemApi
@RequiresPermission(android.Manifest.permission.MANAGE_USERS)
public boolean isUnattendedManagedKiosk() {
throwIfParentInstance("isUnattendedManagedKiosk");
if (mService != null) {
try {
return mService.isUnattendedManagedKiosk();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
/**
* Starts an activity to view calendar events in the managed profile.
*
* @param eventId the id of the event to be viewed
* @param start the start time of the event
* @param end the end time of the event
* @param allDay if the event is an all-day event
* @param flags flags to be set for the intent
* @return {@code true} if the activity is started successfully, {@code false} otherwise
*
* @see CalendarContract#startViewCalendarEventInManagedProfile(Context, String, long, long,
* long, boolean, int)
*
* @hide
*/
public boolean startViewCalendarEventInManagedProfile(long eventId, long start, long end,
boolean allDay, int flags) {
throwIfParentInstance("startViewCalendarEventInManagedProfile");
if (mService != null) {
try {
return mService.startViewCalendarEventInManagedProfile(mContext.getPackageName(),
eventId, start, end, allDay, flags);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
return false;
}
}
|