File size: 129,207 Bytes
8c763fb | 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Management.Automation.Internal;
using System.Management.Automation.Runspaces;
using System.Management.Automation.Tracing;
using System.Reflection;
using System.Threading;
using System.Xml;
using Microsoft.PowerShell.Commands;
using Microsoft.Win32;
using Dbg = System.Management.Automation.Diagnostics;
namespace System.Management.Automation.Remoting
{
#region WSMan endpoint configuration
/// <summary>
/// This struct is used to represent contents from configuration xml. The
/// XML is passed to plugins by WSMan API.
/// This helper does not validate XML content as it is already validated
/// by WSMan.
/// </summary>
internal class ConfigurationDataFromXML
{
#region Config XML Constants
internal const string INITPARAMETERSTOKEN = "InitializationParameters";
internal const string PARAMTOKEN = "Param";
internal const string NAMETOKEN = "Name";
internal const string VALUETOKEN = "Value";
internal const string APPBASETOKEN = "applicationbase";
internal const string ASSEMBLYTOKEN = "assemblyname";
internal const string SHELLCONFIGTYPETOKEN = "pssessionconfigurationtypename";
internal const string STARTUPSCRIPTTOKEN = "startupscript";
internal const string MAXRCVDOBJSIZETOKEN = "psmaximumreceivedobjectsizemb";
internal const string MAXRCVDOBJSIZETOKEN_CamelCase = "PSMaximumReceivedObjectSizeMB";
internal const string MAXRCVDCMDSIZETOKEN = "psmaximumreceiveddatasizepercommandmb";
internal const string MAXRCVDCMDSIZETOKEN_CamelCase = "PSMaximumReceivedDataSizePerCommandMB";
internal const string THREADOPTIONSTOKEN = "pssessionthreadoptions";
internal const string THREADAPTSTATETOKEN = "pssessionthreadapartmentstate";
internal const string SESSIONCONFIGTOKEN = "sessionconfigurationdata";
internal const string PSVERSIONTOKEN = "PSVersion";
internal const string MAXPSVERSIONTOKEN = "MaxPSVersion";
internal const string MODULESTOIMPORT = "ModulesToImport";
internal const string HOSTMODE = "hostmode";
internal const string CONFIGFILEPATH = "configfilepath";
internal const string CONFIGFILEPATH_CamelCase = "ConfigFilePath";
#endregion
#region Fields
internal string StartupScript;
// this field is used only by an Out-Of-Process (IPC) server process
internal string InitializationScriptForOutOfProcessRunspace;
internal string ApplicationBase;
internal string AssemblyName;
internal string EndPointConfigurationTypeName;
internal Type EndPointConfigurationType;
internal int? MaxReceivedObjectSizeMB;
internal int? MaxReceivedCommandSizeMB;
// Used to set properties on the RunspacePool created for this shell.
internal PSThreadOptions? ShellThreadOptions;
internal ApartmentState? ShellThreadApartmentState;
internal PSSessionConfigurationData SessionConfigurationData;
internal string ConfigFilePath;
#endregion
#region Methods
/// <summary>
/// Using optionName and optionValue updates the current object.
/// </summary>
/// <param name="optionName"></param>
/// <param name="optionValue"></param>
/// <exception cref="ArgumentException">
/// 1. "optionName" is not valid in "InitializationParameters" section.
/// 2. "startupscript" must specify a PowerShell script file that ends with extension ".ps1".
/// </exception>
private void Update(string optionName, string optionValue)
{
switch (optionName.ToLowerInvariant())
{
case APPBASETOKEN:
AssertValueNotAssigned(APPBASETOKEN, ApplicationBase);
// this is a folder pointing to application base of the plugin shell
// allow the folder path to use environment variables.
ApplicationBase = Environment.ExpandEnvironmentVariables(optionValue);
break;
case ASSEMBLYTOKEN:
AssertValueNotAssigned(ASSEMBLYTOKEN, AssemblyName);
AssemblyName = optionValue;
break;
case SHELLCONFIGTYPETOKEN:
AssertValueNotAssigned(SHELLCONFIGTYPETOKEN, EndPointConfigurationTypeName);
EndPointConfigurationTypeName = optionValue;
break;
case STARTUPSCRIPTTOKEN:
AssertValueNotAssigned(STARTUPSCRIPTTOKEN, StartupScript);
if (!optionValue.EndsWith(".ps1", StringComparison.OrdinalIgnoreCase))
{
throw PSTraceSource.NewArgumentException(STARTUPSCRIPTTOKEN,
RemotingErrorIdStrings.StartupScriptNotCorrect,
STARTUPSCRIPTTOKEN);
}
// allow the script file to exist in any path..and support
// environment variable expansion.
StartupScript = Environment.ExpandEnvironmentVariables(optionValue);
break;
case MAXRCVDOBJSIZETOKEN:
AssertValueNotAssigned(MAXRCVDOBJSIZETOKEN, MaxReceivedObjectSizeMB);
MaxReceivedObjectSizeMB = GetIntValueInBytes(optionValue);
break;
case MAXRCVDCMDSIZETOKEN:
AssertValueNotAssigned(MAXRCVDCMDSIZETOKEN, MaxReceivedCommandSizeMB);
MaxReceivedCommandSizeMB = GetIntValueInBytes(optionValue);
break;
case THREADOPTIONSTOKEN:
AssertValueNotAssigned(THREADOPTIONSTOKEN, ShellThreadOptions);
ShellThreadOptions = (PSThreadOptions)LanguagePrimitives.ConvertTo(
optionValue, typeof(PSThreadOptions), CultureInfo.InvariantCulture);
break;
case THREADAPTSTATETOKEN:
AssertValueNotAssigned(THREADAPTSTATETOKEN, ShellThreadApartmentState);
ShellThreadApartmentState = (ApartmentState)LanguagePrimitives.ConvertTo(
optionValue, typeof(ApartmentState), CultureInfo.InvariantCulture);
break;
case SESSIONCONFIGTOKEN:
{
AssertValueNotAssigned(SESSIONCONFIGTOKEN, SessionConfigurationData);
SessionConfigurationData = PSSessionConfigurationData.Create(optionValue);
}
break;
case CONFIGFILEPATH:
{
AssertValueNotAssigned(CONFIGFILEPATH, ConfigFilePath);
ConfigFilePath = optionValue;
}
break;
default:
// we dont need to evaluate PSVersion and other custom authz
// related tokens
break;
}
}
/// <summary>
/// Checks if the originalValue is empty. If not throws an exception.
/// </summary>
/// <param name="optionName"></param>
/// <param name="originalValue"></param>
/// <exception cref="ArgumentException">
/// 1. "optionName" is already defined
/// </exception>
private static void AssertValueNotAssigned(string optionName, object originalValue)
{
if (originalValue != null)
{
throw PSTraceSource.NewArgumentException(optionName,
RemotingErrorIdStrings.DuplicateInitializationParameterFound, optionName, INITPARAMETERSTOKEN);
}
}
/// <summary>
/// Converts the value specified by <paramref name="optionValue"/> to int.
/// Multiplies the value by 1MB (1024*1024) to get the number in bytes.
/// </summary>
/// <param name="optionValueInMB"></param>
/// <returns>
/// If value is specified, specified value as int . otherwise null.
/// </returns>
private static int? GetIntValueInBytes(string optionValueInMB)
{
int? result = null;
try
{
double variableValue = (double)LanguagePrimitives.ConvertTo(optionValueInMB,
typeof(double), System.Globalization.CultureInfo.InvariantCulture);
result = unchecked((int)(variableValue * 1024 * 1024)); // Multiply by 1MB
}
catch (InvalidCastException)
{
}
if (result < 0)
{
result = null;
}
return result;
}
/// <summary>
/// Creates the struct from initialization parameters xml.
/// </summary>
/// <param name="initializationParameters">
/// Initialization Parameters xml passed by WSMan API. This data is read from the config
/// xml and is in the following format:
/// </param>
/// <returns></returns>
/// <exception cref="ArgumentException">
/// 1. "optionName" is already defined
/// </exception>
/*
<InitializationParameters>
<Param Name="PSVersion" Value="2.0" />
<Param Name="ApplicationBase" Value="<folder path>" />
...
</InitializationParameters>
*/
/* The following extensions have been added in V3 providing the user
* the ability to pass data to the session configuration for initialization
*
<Param Name="SessionConfigurationData" Value="<SessionConfigurationData with XML escaping>" />
*
* The session configuration data blob can be defined as under
<SessionConfigurationData>
<Param Name="ModulesToImport" Value="<folder path>" />
<Param Name="PrivateData" />
<PrivateData>
...
</PrivateData>
</Param>
</SessionConfigurationData>
*/
internal static ConfigurationDataFromXML Create(string initializationParameters)
{
ConfigurationDataFromXML result = new ConfigurationDataFromXML();
if (string.IsNullOrEmpty(initializationParameters))
{
return result;
}
XmlReaderSettings readerSettings = new XmlReaderSettings();
readerSettings.CheckCharacters = false;
readerSettings.IgnoreComments = true;
readerSettings.IgnoreProcessingInstructions = true;
readerSettings.MaxCharactersInDocument = 10000;
readerSettings.ConformanceLevel = ConformanceLevel.Fragment;
using (XmlReader reader = XmlReader.Create(new StringReader(initializationParameters), readerSettings))
{
// read the header <InitializationParameters>
if (reader.ReadToFollowing(INITPARAMETERSTOKEN))
{
bool isParamFound = reader.ReadToDescendant(PARAMTOKEN);
while (isParamFound)
{
if (!reader.MoveToAttribute(NAMETOKEN))
{
throw PSTraceSource.NewArgumentException(initializationParameters,
RemotingErrorIdStrings.NoAttributesFoundForParamElement,
NAMETOKEN, VALUETOKEN, PARAMTOKEN);
}
string optionName = reader.Value;
if (!reader.MoveToAttribute(VALUETOKEN))
{
throw PSTraceSource.NewArgumentException(initializationParameters,
RemotingErrorIdStrings.NoAttributesFoundForParamElement,
NAMETOKEN, VALUETOKEN, PARAMTOKEN);
}
string optionValue = reader.Value;
result.Update(optionName, optionValue);
// move to next Param token.
isParamFound = reader.ReadToFollowing(PARAMTOKEN);
}
}
}
// assign defaults after parsing the xml content.
result.MaxReceivedObjectSizeMB ??= BaseTransportManager.MaximumReceivedObjectSize;
result.MaxReceivedCommandSizeMB ??= BaseTransportManager.MaximumReceivedDataSize;
return result;
}
/// <summary>
/// </summary>
/// <returns></returns>
/// <exception cref="ArgumentException">
/// 1. Unable to load type "{0}" specified in "InitializationParameters" section.
/// </exception>
internal PSSessionConfiguration CreateEndPointConfigurationInstance()
{
try
{
return (PSSessionConfiguration)Activator.CreateInstance(EndPointConfigurationType);
}
catch (TypeLoadException)
{
}
catch (ArgumentException)
{
}
catch (MissingMethodException)
{
}
catch (InvalidCastException)
{
}
catch (TargetInvocationException)
{
}
// if we are here, that means we are unable to load the type specified
// in the config xml.. notify the same.
throw PSTraceSource.NewArgumentException("typeToLoad", RemotingErrorIdStrings.UnableToLoadType,
EndPointConfigurationTypeName, ConfigurationDataFromXML.INITPARAMETERSTOKEN);
}
#endregion
}
/// <summary>
/// InitialSessionStateProvider is used by 3rd parties to provide shell configuration
/// on the remote server.
/// </summary>
public abstract class PSSessionConfiguration : IDisposable
{
#region tracer
/// <summary>
/// Tracer for Server Remote session.
/// </summary>
[TraceSource("ServerRemoteSession", "ServerRemoteSession")]
private static readonly PSTraceSource s_tracer = PSTraceSource.GetTracer("ServerRemoteSession", "ServerRemoteSession");
#endregion tracer
#region public interfaces
/// <summary>
/// Derived classes must override this to supply an InitialSessionState
/// to be used to construct a Runspace for the user.
/// </summary>
/// <param name="senderInfo">
/// User Identity for which this information is requested
/// </param>
/// <returns></returns>
public abstract InitialSessionState GetInitialSessionState(PSSenderInfo senderInfo);
/// <summary>
/// </summary>
/// <param name="sessionConfigurationData"></param>
/// <param name="senderInfo"></param>
/// <param name="configProviderId"></param>
/// <returns></returns>
public virtual InitialSessionState GetInitialSessionState(PSSessionConfigurationData sessionConfigurationData,
PSSenderInfo senderInfo, string configProviderId)
{
throw new NotImplementedException();
}
/// <summary>
/// Maximum size (in bytes) of a deserialized object received from a remote machine.
/// If null, then the size is unlimited. Default is 10MB.
/// </summary>
/// <param name="senderInfo">
/// User Identity for which this information is requested
/// </param>
/// <returns></returns>
public virtual int? GetMaximumReceivedObjectSize(PSSenderInfo senderInfo)
{
return BaseTransportManager.MaximumReceivedObjectSize;
}
/// <summary>
/// Total data (in bytes) that can be received from a remote machine
/// targeted towards a command. If null, then the size is unlimited.
/// Default is 50MB.
/// </summary>
/// <param name="senderInfo">
/// User Identity for which this information is requested
/// </param>
/// <returns></returns>
public virtual int? GetMaximumReceivedDataSizePerCommand(PSSenderInfo senderInfo)
{
return BaseTransportManager.MaximumReceivedDataSize;
}
/// <summary>
/// Derived classes can override this method to provide application private data
/// that is going to be sent to the client and exposed via
/// <see cref="System.Management.Automation.Runspaces.PSSession.ApplicationPrivateData"/>,
/// <see cref="System.Management.Automation.Runspaces.Runspace.GetApplicationPrivateData"/> and
/// <see cref="System.Management.Automation.Runspaces.RunspacePool.GetApplicationPrivateData"/>
/// </summary>
/// <param name="senderInfo">
/// User Identity for which this information is requested
/// </param>
/// <returns>Application private data or <see langword="null"/></returns>
public virtual PSPrimitiveDictionary GetApplicationPrivateData(PSSenderInfo senderInfo)
{
return null;
}
#endregion
#region IDisposable Overrides
/// <summary>
/// Dispose this configuration object. This will be called when a Runspace/RunspacePool
/// created using InitialSessionState from this object is Closed.
/// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>
/// </summary>
/// <param name="isDisposing"></param>
protected virtual void Dispose(bool isDisposing)
{
}
#endregion
#region GetInitialSessionState from 3rd party shell ids
/// <summary>
/// </summary>
/// <param name="shellId"></param>
/// <param name="initializationParameters">
/// Initialization Parameters xml passed by WSMan API. This data is read from the config
/// xml and is in the following format:
/// </param>
/// <returns></returns>
/// <exception cref="InvalidOperationException">
/// 1. Non existent InitialSessionState provider for the shellID
/// </exception>
/*
<InitializationParameters>
<Param Name="PSVersion" Value="2.0" />
<Param Name="ApplicationBase" Value="<folder path>" />
...
</InitializationParameters>
*/
internal static ConfigurationDataFromXML LoadEndPointConfiguration(
string shellId,
string initializationParameters)
{
ConfigurationDataFromXML configData = null;
if (!s_ssnStateProviders.ContainsKey(initializationParameters))
{
LoadRSConfigProvider(shellId, initializationParameters);
}
lock (s_syncObject)
{
if (!s_ssnStateProviders.TryGetValue(initializationParameters, out configData))
{
throw PSTraceSource.NewInvalidOperationException(RemotingErrorIdStrings.NonExistentInitialSessionStateProvider, shellId);
}
}
return configData;
}
private static void LoadRSConfigProvider(string shellId, string initializationParameters)
{
ConfigurationDataFromXML configData = ConfigurationDataFromXML.Create(initializationParameters);
Type endPointConfigType = LoadAndAnalyzeAssembly(shellId,
configData.ApplicationBase,
configData.AssemblyName,
configData.EndPointConfigurationTypeName);
Dbg.Assert(endPointConfigType != null, "EndPointConfiguration type cannot be null");
configData.EndPointConfigurationType = endPointConfigType;
lock (s_syncObject)
{
if (!s_ssnStateProviders.ContainsKey(initializationParameters))
{
s_ssnStateProviders.Add(initializationParameters, configData);
}
}
}
/// <summary>
/// </summary>
/// <param name="shellId">
/// shellId for which the assembly is getting loaded
/// </param>
/// <param name="applicationBase"></param>
/// <param name="assemblyName"></param>
/// <param name="typeToLoad">
/// type which is supplying the configuration.
/// </param>
/// <exception cref="InvalidOperationException">
/// </exception>
/// <returns>
/// Type instance representing the EndPointConfiguration to load.
/// This Type can be instantiated when needed.
/// </returns>
private static Type LoadAndAnalyzeAssembly(string shellId, string applicationBase,
string assemblyName, string typeToLoad)
{
if ((string.IsNullOrEmpty(assemblyName) && !string.IsNullOrEmpty(typeToLoad)) ||
(!string.IsNullOrEmpty(assemblyName) && string.IsNullOrEmpty(typeToLoad)))
{
throw PSTraceSource.NewInvalidOperationException(RemotingErrorIdStrings.TypeNeedsAssembly,
ConfigurationDataFromXML.ASSEMBLYTOKEN,
ConfigurationDataFromXML.SHELLCONFIGTYPETOKEN,
ConfigurationDataFromXML.INITPARAMETERSTOKEN);
}
Assembly assembly = null;
if (!string.IsNullOrEmpty(assemblyName))
{
PSEtwLog.LogAnalyticVerbose(PSEventId.LoadingPSCustomShellAssembly,
PSOpcode.Connect, PSTask.None, PSKeyword.Transport | PSKeyword.UseAlwaysAnalytic,
assemblyName, shellId);
assembly = LoadSsnStateProviderAssembly(applicationBase, assemblyName);
if (assembly == null)
{
throw PSTraceSource.NewArgumentException(nameof(assemblyName), RemotingErrorIdStrings.UnableToLoadAssembly,
assemblyName, ConfigurationDataFromXML.INITPARAMETERSTOKEN);
}
}
// configuration xml specified an assembly and typetoload.
if (assembly != null)
{
try
{
PSEtwLog.LogAnalyticVerbose(PSEventId.LoadingPSCustomShellType,
PSOpcode.Connect, PSTask.None, PSKeyword.Transport | PSKeyword.UseAlwaysAnalytic,
typeToLoad, shellId);
Type type = assembly.GetType(typeToLoad, true, true);
if (type == null)
{
throw PSTraceSource.NewArgumentException(nameof(typeToLoad), RemotingErrorIdStrings.UnableToLoadType,
typeToLoad, ConfigurationDataFromXML.INITPARAMETERSTOKEN);
}
return type;
}
catch (ReflectionTypeLoadException)
{
}
catch (TypeLoadException)
{
}
catch (ArgumentException)
{
}
catch (MissingMethodException)
{
}
catch (InvalidCastException)
{
}
catch (TargetInvocationException)
{
}
// if we are here, that means we are unable to load the type specified
// in the config xml.. notify the same.
throw PSTraceSource.NewArgumentException(nameof(typeToLoad), RemotingErrorIdStrings.UnableToLoadType,
typeToLoad, ConfigurationDataFromXML.INITPARAMETERSTOKEN);
}
// load the default PowerShell since plugin config
// did not specify a typename to load.
return typeof(DefaultRemotePowerShellConfiguration);
}
/// <summary>
/// Sets the application's current working directory to <paramref name="applicationBase"/> and
/// loads the assembly <paramref name="assemblyName"/>. Once the assembly is loaded, the application's
/// current working directory is set back to the original value.
/// </summary>
/// <param name="applicationBase"></param>
/// <param name="assemblyName"></param>
/// <returns></returns>
// TODO: Send the exception message back to the client.
[SuppressMessage("Microsoft.Reliability", "CA2001:AvoidCallingProblematicMethods", MessageId = "System.Reflection.Assembly.LoadFrom")]
private static Assembly LoadSsnStateProviderAssembly(string applicationBase, string assemblyName)
{
Dbg.Assert(!string.IsNullOrEmpty(assemblyName), "AssemblyName cannot be null.");
string originalDirectory = string.Empty;
if (!string.IsNullOrEmpty(applicationBase))
{
// changing current working directory allows CLR loader to load dependent assemblies
try
{
originalDirectory = Directory.GetCurrentDirectory();
Directory.SetCurrentDirectory(applicationBase);
}
catch (ArgumentException e)
{
s_tracer.TraceWarning("Not able to change current working directory to {0}: {1}",
applicationBase, e.Message);
}
catch (PathTooLongException e)
{
s_tracer.TraceWarning("Not able to change current working directory to {0}: {1}",
applicationBase, e.Message);
}
catch (FileNotFoundException e)
{
s_tracer.TraceWarning("Not able to change current working directory to {0}: {1}",
applicationBase, e.Message);
}
catch (IOException e)
{
s_tracer.TraceWarning("Not able to change current working directory to {0}: {1}",
applicationBase, e.Message);
}
catch (System.Security.SecurityException e)
{
s_tracer.TraceWarning("Not able to change current working directory to {0}: {1}",
applicationBase, e.Message);
}
catch (UnauthorizedAccessException e)
{
s_tracer.TraceWarning("Not able to change current working directory to {0}: {1}",
applicationBase, e.Message);
}
}
// Even if there is error changing current working directory..try to load the assembly
// This is to allow assembly loading from GAC
Assembly result = null;
try
{
try
{
result = Assembly.Load(new AssemblyName(assemblyName));
}
catch (FileLoadException e)
{
s_tracer.TraceWarning("Not able to load assembly {0}: {1}", assemblyName, e.Message);
}
catch (BadImageFormatException e)
{
s_tracer.TraceWarning("Not able to load assembly {0}: {1}", assemblyName, e.Message);
}
catch (FileNotFoundException e)
{
s_tracer.TraceWarning("Not able to load assembly {0}: {1}", assemblyName, e.Message);
}
if (result != null)
{
return result;
}
s_tracer.WriteLine("Loading assembly from path {0}", applicationBase);
try
{
string assemblyPath;
if (!Path.IsPathRooted(assemblyName))
{
if (!string.IsNullOrEmpty(applicationBase) && Directory.Exists(applicationBase))
{
assemblyPath = Path.Combine(applicationBase, assemblyName);
}
else
{
assemblyPath = Path.Combine(Directory.GetCurrentDirectory(), assemblyName);
}
}
else
{
// Rooted path of dll is provided.
assemblyPath = assemblyName;
}
result = Assembly.LoadFrom(assemblyPath);
}
catch (FileLoadException e)
{
s_tracer.TraceWarning("Not able to load assembly {0}: {1}", assemblyName, e.Message);
}
catch (BadImageFormatException e)
{
s_tracer.TraceWarning("Not able to load assembly {0}: {1}", assemblyName, e.Message);
}
catch (FileNotFoundException e)
{
s_tracer.TraceWarning("Not able to load assembly {0}: {1}", assemblyName, e.Message);
}
}
finally
{
if (!string.IsNullOrEmpty(applicationBase))
{
// set the application's directory back to the original directory
Directory.SetCurrentDirectory(originalDirectory);
}
}
return result;
}
// TODO: I think this should be moved to Utils..this way all versioning related
// logic will be in one place.
private static RegistryKey GetConfigurationProvidersRegistryKey()
{
try
{
RegistryKey monadRootKey = PSSnapInReader.GetMonadRootKey();
RegistryKey versionRoot = PSSnapInReader.GetVersionRootKey(monadRootKey, Utils.GetCurrentMajorVersion());
RegistryKey configProviderKey = versionRoot.OpenSubKey(configProvidersKeyName);
return configProviderKey;
}
catch (ArgumentException)
{
}
catch (System.Security.SecurityException)
{
}
return null;
}
/// <summary>
/// Read value from the property <paramref name="name"/> for registry <paramref name="registryKey"/>
/// as string.
/// </summary>
/// <param name="registryKey">
/// Registry key from which the value is read.
/// Caller should make sure this is not null.
/// </param>
/// <param name="name">
/// Name of the property.
/// Caller should make sure this is not null.
/// </param>
/// <param name="mandatory">
/// True, if the property should exist.
/// False, otherwise.
/// </param>
/// <returns>
/// Value of the property.
/// </returns>
/// <exception cref="ArgumentException">
/// </exception>
/// <exception cref="System.Security.SecurityException">
/// </exception>
private static string
ReadStringValue(RegistryKey registryKey, string name, bool mandatory)
{
Dbg.Assert(!string.IsNullOrEmpty(name), "caller should validate the name parameter");
Dbg.Assert(registryKey != null, "Caller should validate the registryKey parameter");
object value = registryKey.GetValue(name);
if (value == null && mandatory)
{
s_tracer.TraceError("Mandatory property {0} not specified for registry key {1}",
name, registryKey.Name);
throw PSTraceSource.NewArgumentException(nameof(name), RemotingErrorIdStrings.MandatoryValueNotPresent, name, registryKey.Name);
}
string s = value as string;
if (string.IsNullOrEmpty(s) && mandatory)
{
s_tracer.TraceError("Value is null or empty for mandatory property {0} in {1}",
name, registryKey.Name);
throw PSTraceSource.NewArgumentException(nameof(name), RemotingErrorIdStrings.MandatoryValueNotInCorrectFormat, name, registryKey.Name);
}
return s;
}
private const string configProvidersKeyName = "PSConfigurationProviders";
private const string configProviderApplicationBaseKeyName = "ApplicationBase";
private const string configProviderAssemblyNameKeyName = "AssemblyName";
private static readonly Dictionary<string, ConfigurationDataFromXML> s_ssnStateProviders =
new Dictionary<string, ConfigurationDataFromXML>(StringComparer.OrdinalIgnoreCase);
private static readonly object s_syncObject = new object();
#endregion
}
/// <summary>
/// Provides Default InitialSessionState.
/// </summary>
internal sealed class DefaultRemotePowerShellConfiguration : PSSessionConfiguration
{
#region Method overrides
/// <summary>
/// </summary>
/// <param name="senderInfo"></param>
/// <returns></returns>
public override InitialSessionState GetInitialSessionState(PSSenderInfo senderInfo)
{
InitialSessionState result = InitialSessionState.CreateDefault2();
// TODO: Remove this after RDS moved to $using
if (senderInfo.ConnectionString != null && senderInfo.ConnectionString.Contains("MSP=7a83d074-bb86-4e52-aa3e-6cc73cc066c8"))
{
PSSessionConfigurationData.IsServerManager = true;
}
return result;
}
public override InitialSessionState GetInitialSessionState(PSSessionConfigurationData sessionConfigurationData, PSSenderInfo senderInfo, string configProviderId)
{
ArgumentNullException.ThrowIfNull(sessionConfigurationData);
ArgumentNullException.ThrowIfNull(senderInfo);
ArgumentNullException.ThrowIfNull(configProviderId);
InitialSessionState sessionState = InitialSessionState.CreateDefault2();
// now get all the modules in the specified path and import the same
if (sessionConfigurationData != null && sessionConfigurationData.ModulesToImportInternal != null)
{
foreach (var module in sessionConfigurationData.ModulesToImportInternal)
{
var moduleName = module as string;
if (moduleName != null)
{
moduleName = Environment.ExpandEnvironmentVariables(moduleName);
sessionState.ImportPSModule(new[] { moduleName });
}
else
{
var moduleSpec = module as ModuleSpecification;
if (moduleSpec != null)
{
var modulesToImport = new Collection<ModuleSpecification> { moduleSpec };
sessionState.ImportPSModule(modulesToImport);
}
}
}
}
// TODO: Remove this after RDS moved to $using
if (senderInfo.ConnectionString != null && senderInfo.ConnectionString.Contains("MSP=7a83d074-bb86-4e52-aa3e-6cc73cc066c8"))
{
PSSessionConfigurationData.IsServerManager = true;
}
return sessionState;
}
#endregion
}
#endregion
#region Declarative InitialSession Configuration
#region Supporting types
/// <summary>
/// Specifies type of initial session state to use. Valid values are Empty and Default.
/// </summary>
public enum SessionType
{
/// <summary>
/// Empty session state.
/// </summary>
Empty,
/// <summary>
/// Restricted remote server.
/// </summary>
RestrictedRemoteServer,
/// <summary>
/// Default session state.
/// </summary>
Default
}
/// <summary>
/// Configuration type entry.
/// </summary>
internal class ConfigTypeEntry
{
internal delegate bool TypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path);
internal string Key;
internal TypeValidationCallback ValidationCallback;
/// <summary>
/// </summary>
/// <param name="key"></param>
/// <param name="callback"></param>
internal ConfigTypeEntry(string key, TypeValidationCallback callback)
{
this.Key = key;
this.ValidationCallback = callback;
}
}
#endregion
#region ConfigFileConstants
/// <summary>
/// Configuration file constants.
/// </summary>
internal static class ConfigFileConstants
{
internal static readonly string AliasDefinitions = "AliasDefinitions";
internal static readonly string AliasDescriptionToken = "Description";
internal static readonly string AliasNameToken = "Name";
internal static readonly string AliasOptionsToken = "Options";
internal static readonly string AliasValueToken = "Value";
internal static readonly string AssembliesToLoad = "AssembliesToLoad";
internal static readonly string Author = "Author";
internal static readonly string CompanyName = "CompanyName";
internal static readonly string Copyright = "Copyright";
internal static readonly string Description = "Description";
internal static readonly string EnforceInputParameterValidation = "EnforceInputParameterValidation";
internal static readonly string EnvironmentVariables = "EnvironmentVariables";
internal static readonly string ExecutionPolicy = "ExecutionPolicy";
internal static readonly string FormatsToProcess = "FormatsToProcess";
internal static readonly string FunctionDefinitions = "FunctionDefinitions";
internal static readonly string FunctionNameToken = "Name";
internal static readonly string FunctionOptionsToken = "Options";
internal static readonly string FunctionValueToken = "ScriptBlock";
internal static readonly string GMSAAccount = "GroupManagedServiceAccount";
internal static readonly string Guid = "GUID";
internal static readonly string LanguageMode = "LanguageMode";
internal static readonly string ModulesToImport = "ModulesToImport";
internal static readonly string MountUserDrive = "MountUserDrive";
internal static readonly string PowerShellVersion = "PowerShellVersion";
internal static readonly string RequiredGroups = "RequiredGroups";
internal static readonly string RoleDefinitions = "RoleDefinitions";
internal static readonly string SchemaVersion = "SchemaVersion";
internal static readonly string ScriptsToProcess = "ScriptsToProcess";
internal static readonly string SessionType = "SessionType";
internal static readonly string RoleCapabilities = "RoleCapabilities";
internal static readonly string RoleCapabilityFiles = "RoleCapabilityFiles";
internal static readonly string RunAsVirtualAccount = "RunAsVirtualAccount";
internal static readonly string RunAsVirtualAccountGroups = "RunAsVirtualAccountGroups";
internal static readonly string TranscriptDirectory = "TranscriptDirectory";
internal static readonly string TypesToProcess = "TypesToProcess";
internal static readonly string UserDriveMaxSize = "UserDriveMaximumSize";
internal static readonly string VariableDefinitions = "VariableDefinitions";
internal static readonly string VariableNameToken = "Name";
internal static readonly string VariableValueToken = "Value";
internal static readonly string VisibleAliases = "VisibleAliases";
internal static readonly string VisibleCmdlets = "VisibleCmdlets";
internal static readonly string VisibleFunctions = "VisibleFunctions";
internal static readonly string VisibleProviders = "VisibleProviders";
internal static readonly string VisibleExternalCommands = "VisibleExternalCommands";
internal static readonly ConfigTypeEntry[] ConfigFileKeys = new ConfigTypeEntry[] {
new ConfigTypeEntry(AliasDefinitions, new ConfigTypeEntry.TypeValidationCallback(AliasDefinitionsTypeValidationCallback)),
new ConfigTypeEntry(AssembliesToLoad, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(Author, new ConfigTypeEntry.TypeValidationCallback(StringTypeValidationCallback)),
new ConfigTypeEntry(CompanyName, new ConfigTypeEntry.TypeValidationCallback(StringTypeValidationCallback)),
new ConfigTypeEntry(Copyright, new ConfigTypeEntry.TypeValidationCallback(StringTypeValidationCallback)),
new ConfigTypeEntry(Description, new ConfigTypeEntry.TypeValidationCallback(StringTypeValidationCallback)),
new ConfigTypeEntry(EnforceInputParameterValidation, new ConfigTypeEntry.TypeValidationCallback(BooleanTypeValidationCallback)),
new ConfigTypeEntry(EnvironmentVariables, new ConfigTypeEntry.TypeValidationCallback(HashtableTypeValidationCallback)),
new ConfigTypeEntry(ExecutionPolicy, new ConfigTypeEntry.TypeValidationCallback(ExecutionPolicyValidationCallback)),
new ConfigTypeEntry(FormatsToProcess, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(FunctionDefinitions, new ConfigTypeEntry.TypeValidationCallback(FunctionDefinitionsTypeValidationCallback)),
new ConfigTypeEntry(GMSAAccount, new ConfigTypeEntry.TypeValidationCallback(StringTypeValidationCallback)),
new ConfigTypeEntry(Guid, new ConfigTypeEntry.TypeValidationCallback(StringTypeValidationCallback)),
new ConfigTypeEntry(LanguageMode, new ConfigTypeEntry.TypeValidationCallback(LanguageModeValidationCallback)),
new ConfigTypeEntry(ModulesToImport, new ConfigTypeEntry.TypeValidationCallback(StringOrHashtableArrayTypeValidationCallback)),
new ConfigTypeEntry(MountUserDrive, new ConfigTypeEntry.TypeValidationCallback(BooleanTypeValidationCallback)),
new ConfigTypeEntry(PowerShellVersion, new ConfigTypeEntry.TypeValidationCallback(StringTypeValidationCallback)),
new ConfigTypeEntry(RequiredGroups, new ConfigTypeEntry.TypeValidationCallback(HashtableTypeValidationCallback)),
new ConfigTypeEntry(RoleCapabilities, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(RoleCapabilityFiles, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(RoleDefinitions, new ConfigTypeEntry.TypeValidationCallback(HashtableTypeValidationCallback)),
new ConfigTypeEntry(RunAsVirtualAccount, new ConfigTypeEntry.TypeValidationCallback(BooleanTypeValidationCallback)),
new ConfigTypeEntry(RunAsVirtualAccountGroups, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(SchemaVersion, new ConfigTypeEntry.TypeValidationCallback(StringTypeValidationCallback)),
new ConfigTypeEntry(ScriptsToProcess, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(SessionType, new ConfigTypeEntry.TypeValidationCallback(ISSValidationCallback)),
new ConfigTypeEntry(TranscriptDirectory, new ConfigTypeEntry.TypeValidationCallback(StringTypeValidationCallback)),
new ConfigTypeEntry(TypesToProcess, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(UserDriveMaxSize, new ConfigTypeEntry.TypeValidationCallback(IntegerTypeValidationCallback)),
new ConfigTypeEntry(VariableDefinitions, new ConfigTypeEntry.TypeValidationCallback(VariableDefinitionsTypeValidationCallback)),
new ConfigTypeEntry(VisibleAliases, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(VisibleCmdlets, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(VisibleFunctions, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(VisibleProviders, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
new ConfigTypeEntry(VisibleExternalCommands, new ConfigTypeEntry.TypeValidationCallback(StringArrayTypeValidationCallback)),
};
/// <summary>
/// Checks if the given key is a valid key.
/// </summary>
/// <param name="de"></param>
/// <param name="cmdlet"></param>
/// <param name="path"></param>
/// <returns></returns>
internal static bool IsValidKey(DictionaryEntry de, PSCmdlet cmdlet, string path)
{
bool validKey = false;
foreach (ConfigTypeEntry configEntry in ConfigFileKeys)
{
if (string.Equals(configEntry.Key, de.Key.ToString(), StringComparison.OrdinalIgnoreCase))
{
validKey = true;
if (configEntry.ValidationCallback(de.Key.ToString(), de.Value, cmdlet, path))
{
return true;
}
}
}
if (!validKey)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCInvalidKey, de.Key.ToString(), path));
}
return false;
}
/// <summary>
/// </summary>
/// <param name="key"></param>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool ISSValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
string value = obj as string;
if (!string.IsNullOrEmpty(value))
{
try
{
Enum.Parse(typeof(SessionType), value, true);
return true;
}
catch (ArgumentException)
{
// Do nothing here
}
}
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeValidEnum, key, typeof(SessionType).FullName,
LanguagePrimitives.EnumSingleTypeConverter.EnumValues(typeof(SessionType)), path));
return false;
}
/// <summary>
/// </summary>
/// <param name="key"></param>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool LanguageModeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
string value = obj as string;
if (!string.IsNullOrEmpty(value))
{
try
{
Enum.Parse(typeof(PSLanguageMode), value, true);
return true;
}
catch (ArgumentException)
{
// Do nothing here
}
}
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeValidEnum, key, typeof(PSLanguageMode).FullName,
LanguagePrimitives.EnumSingleTypeConverter.EnumValues(typeof(PSLanguageMode)), path));
return false;
}
/// <summary>
/// </summary>
/// <param name="key"></param>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool ExecutionPolicyValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
string value = obj as string;
if (!string.IsNullOrEmpty(value))
{
try
{
Enum.Parse(DISCUtils.ExecutionPolicyType, value, true);
return true;
}
catch (ArgumentException)
{
// Do nothing here
}
}
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeValidEnum, key, DISCUtils.ExecutionPolicyType.FullName,
LanguagePrimitives.EnumSingleTypeConverter.EnumValues(DISCUtils.ExecutionPolicyType), path));
return false;
}
/// <summary>
/// </summary>
/// <param name="key"></param>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool HashtableTypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
Hashtable hash = obj as Hashtable;
if (hash == null)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeHashtable, key, path));
return false;
}
return true;
}
/// <summary>
/// </summary>
/// <param name="key"></param>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool AliasDefinitionsTypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
Hashtable[] hashtables = DISCPowerShellConfiguration.TryGetHashtableArray(obj);
if (hashtables == null)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeHashtableArray, key, path));
return false;
}
foreach (Hashtable hashtable in hashtables)
{
if (!hashtable.ContainsKey(AliasNameToken))
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustContainKey, key, AliasNameToken, path));
return false;
}
if (!hashtable.ContainsKey(AliasValueToken))
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustContainKey, key, AliasValueToken, path));
return false;
}
foreach (string aliasKey in hashtable.Keys)
{
if (!string.Equals(aliasKey, AliasNameToken, StringComparison.OrdinalIgnoreCase) &&
!string.Equals(aliasKey, AliasValueToken, StringComparison.OrdinalIgnoreCase) &&
!string.Equals(aliasKey, AliasDescriptionToken, StringComparison.OrdinalIgnoreCase) &&
!string.Equals(aliasKey, AliasOptionsToken, StringComparison.OrdinalIgnoreCase))
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeContainsInvalidKey, aliasKey, key, path));
return false;
}
}
}
return true;
}
/// <summary>
/// </summary>
/// <param name="key"></param>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool FunctionDefinitionsTypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
Hashtable[] hashtables = DISCPowerShellConfiguration.TryGetHashtableArray(obj);
if (hashtables == null)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeHashtableArray, key, path));
return false;
}
foreach (Hashtable hashtable in hashtables)
{
if (!hashtable.ContainsKey(FunctionNameToken))
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustContainKey, key, FunctionNameToken, path));
return false;
}
if (!hashtable.ContainsKey(FunctionValueToken))
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustContainKey, key, FunctionValueToken, path));
return false;
}
if (hashtable[FunctionValueToken] is not ScriptBlock)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCKeyMustBeScriptBlock, FunctionValueToken, key, path));
return false;
}
foreach (string functionKey in hashtable.Keys)
{
if (!string.Equals(functionKey, FunctionNameToken, StringComparison.OrdinalIgnoreCase) &&
!string.Equals(functionKey, FunctionValueToken, StringComparison.OrdinalIgnoreCase) &&
!string.Equals(functionKey, FunctionOptionsToken, StringComparison.OrdinalIgnoreCase))
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeContainsInvalidKey, functionKey, key, path));
return false;
}
}
}
return true;
}
/// <summary>
/// </summary>
/// <param name="key"></param>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool VariableDefinitionsTypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
Hashtable[] hashtables = DISCPowerShellConfiguration.TryGetHashtableArray(obj);
if (hashtables == null)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeHashtableArray, key, path));
return false;
}
foreach (Hashtable hashtable in hashtables)
{
if (!hashtable.ContainsKey(VariableNameToken))
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustContainKey, key, VariableNameToken, path));
return false;
}
if (!hashtable.ContainsKey(VariableValueToken))
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustContainKey, key, VariableValueToken, path));
return false;
}
foreach (string variableKey in hashtable.Keys)
{
if (!string.Equals(variableKey, VariableNameToken, StringComparison.OrdinalIgnoreCase) &&
!string.Equals(variableKey, VariableValueToken, StringComparison.OrdinalIgnoreCase))
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeContainsInvalidKey, variableKey, key, path));
return false;
}
}
}
return true;
}
/// <summary>
/// Verifies a string type.
/// </summary>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="key"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool StringTypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
if (obj is not string)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeString, key, path));
return false;
}
return true;
}
/// <summary>
/// Verifies a string array type.
/// </summary>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="key"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool StringArrayTypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
if (DISCPowerShellConfiguration.TryGetStringArray(obj) == null)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeStringArray, key, path));
return false;
}
return true;
}
private static bool BooleanTypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
if (obj is not bool)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeBoolean, key, path));
return false;
}
return true;
}
private static bool IntegerTypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
if (obj is not int && obj is not long)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeInteger, key, path));
return false;
}
return true;
}
/// <summary>
/// Verifies that an array contains only string or hashtable elements.
/// </summary>
/// <param name="obj"></param>
/// <param name="cmdlet"></param>
/// <param name="key"></param>
/// <param name="path"></param>
/// <returns></returns>
private static bool StringOrHashtableArrayTypeValidationCallback(string key, object obj, PSCmdlet cmdlet, string path)
{
if (DISCPowerShellConfiguration.TryGetObjectsOfType<object>(obj, new Type[] { typeof(string), typeof(Hashtable) }) == null)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeStringOrHashtableArrayInFile, key, path));
return false;
}
return true;
}
}
#endregion
#region DISC Utilities
/// <summary>
/// DISC utilities.
/// </summary>
internal static class DISCUtils
{
#region Private data
internal static Type ExecutionPolicyType = null;
/// <summary>
/// !! NOTE that this list MUST be updated when new capability session configuration properties are added.
/// </summary>
private static readonly HashSet<string> s_allowedRoleCapabilityKeys = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
{
"RoleCapabilities",
"RoleCapabilityFiles",
"ModulesToImport",
"VisibleAliases",
"VisibleCmdlets",
"VisibleFunctions",
"VisibleExternalCommands",
"VisibleProviders",
"ScriptsToProcess",
"AliasDefinitions",
"FunctionDefinitions",
"VariableDefinitions",
"EnvironmentVariables",
"TypesToProcess",
"FormatsToProcess",
"AssembliesToLoad"
};
#endregion
/// <summary>
/// Create an ExternalScriptInfo object from a file path.
/// </summary>
/// <param name="context">Execution context.</param>
/// <param name="fileName">The path to the file.</param>
/// <param name="scriptName">The base name of the script.</param>
/// <returns>The ExternalScriptInfo object.</returns>
internal static ExternalScriptInfo GetScriptInfoForFile(ExecutionContext context, string fileName, out string scriptName)
{
scriptName = Path.GetFileName(fileName);
ExternalScriptInfo scriptInfo = new ExternalScriptInfo(scriptName, fileName, context);
// Skip ShouldRun check for .psd1 files.
// Use ValidateScriptInfo() for explicitly validating the checkpolicy for psd1 file.
//
if (!scriptName.EndsWith(".psd1", StringComparison.OrdinalIgnoreCase))
{
context.AuthorizationManager.ShouldRunInternal(scriptInfo, CommandOrigin.Internal,
context.EngineHostInterface);
// Verify that the PSversion is correct...
CommandDiscovery.VerifyPSVersion(scriptInfo);
// If we got this far, the check succeeded and we don't need to check again.
scriptInfo.SignatureChecked = true;
}
return scriptInfo;
}
/// <summary>
/// Loads the configuration file into a hashtable.
/// </summary>
/// <param name="context">Execution context.</param>
/// <param name="scriptInfo">The ExternalScriptInfo object.</param>
/// <returns>Configuration hashtable.</returns>
internal static Hashtable LoadConfigFile(ExecutionContext context, ExternalScriptInfo scriptInfo)
{
object result;
object oldPSScriptRoot = context.GetVariableValue(SpecialVariables.PSScriptRootVarPath);
object oldPSCommandPath = context.GetVariableValue(SpecialVariables.PSCommandPathVarPath);
try
{
// Set the PSScriptRoot variable in the modules session state
context.SetVariable(SpecialVariables.PSScriptRootVarPath, Path.GetDirectoryName(scriptInfo.Definition));
context.SetVariable(SpecialVariables.PSCommandPathVarPath, scriptInfo.Definition);
result = PSObject.Base(scriptInfo.ScriptBlock.InvokeReturnAsIs());
}
finally
{
context.SetVariable(SpecialVariables.PSScriptRootVarPath, oldPSScriptRoot);
context.SetVariable(SpecialVariables.PSCommandPathVarPath, oldPSCommandPath);
}
return result as Hashtable;
}
/// <summary>
/// Verifies the configuration hashtable.
/// </summary>
/// <param name="table">Configuration hashtable.</param>
/// <param name="cmdlet"></param>
/// <param name="path"></param>
/// <returns>True if valid, false otherwise.</returns>
internal static bool VerifyConfigTable(Hashtable table, PSCmdlet cmdlet, string path)
{
bool hasSchemaVersion = false;
foreach (DictionaryEntry de in table)
{
if (!ConfigFileConstants.IsValidKey(de, cmdlet, path))
{
return false;
}
if (de.Key.ToString().Equals(ConfigFileConstants.SchemaVersion, StringComparison.OrdinalIgnoreCase))
{
hasSchemaVersion = true;
}
}
if (!hasSchemaVersion)
{
cmdlet.WriteVerbose(StringUtil.Format(RemotingErrorIdStrings.DISCMissingSchemaVersion, path));
return false;
}
try
{
ValidateAbsolutePaths(cmdlet.SessionState, table, path);
ValidateExtensions(table, path);
}
catch (InvalidOperationException e)
{
cmdlet.WriteVerbose(e.Message);
return false;
}
return true;
}
/// <summary>
/// </summary>
private static void ValidatePS1XMLExtension(string key, string[] paths, string filePath)
{
if (paths == null)
{
return;
}
foreach (string path in paths)
{
try
{
string ext = System.IO.Path.GetExtension(path);
if (!ext.Equals(".ps1xml", StringComparison.OrdinalIgnoreCase))
{
throw new InvalidOperationException(StringUtil.Format(RemotingErrorIdStrings.DISCInvalidExtension, key, ext, ".ps1xml"));
}
}
catch (ArgumentException argumentException)
{
throw new InvalidOperationException(StringUtil.Format(RemotingErrorIdStrings.ErrorParsingTheKeyInPSSessionConfigurationFile, key, filePath), argumentException);
}
}
}
/// <summary>
/// </summary>
private static void ValidatePS1OrPSM1Extension(string key, string[] paths, string filePath)
{
if (paths == null)
{
return;
}
foreach (string path in paths)
{
try
{
string ext = System.IO.Path.GetExtension(path);
if (!ext.Equals(StringLiterals.PowerShellScriptFileExtension, StringComparison.OrdinalIgnoreCase) &&
!ext.Equals(StringLiterals.PowerShellModuleFileExtension, StringComparison.OrdinalIgnoreCase))
{
throw new InvalidOperationException(StringUtil.Format(RemotingErrorIdStrings.DISCInvalidExtension, key, ext,
string.Join(", ", StringLiterals.PowerShellScriptFileExtension, StringLiterals.PowerShellModuleFileExtension)));
}
}
catch (ArgumentException argumentException)
{
throw new InvalidOperationException(StringUtil.Format(RemotingErrorIdStrings.ErrorParsingTheKeyInPSSessionConfigurationFile, key, filePath), argumentException);
}
}
}
/// <summary>
/// </summary>
/// <param name="table"></param>
/// <param name="filePath"></param>
internal static void ValidateExtensions(Hashtable table, string filePath)
{
if (table.ContainsKey(ConfigFileConstants.TypesToProcess))
{
ValidatePS1XMLExtension(ConfigFileConstants.TypesToProcess, DISCPowerShellConfiguration.TryGetStringArray(table[ConfigFileConstants.TypesToProcess]), filePath);
}
if (table.ContainsKey(ConfigFileConstants.FormatsToProcess))
{
ValidatePS1XMLExtension(ConfigFileConstants.FormatsToProcess, DISCPowerShellConfiguration.TryGetStringArray(table[ConfigFileConstants.FormatsToProcess]), filePath);
}
if (table.ContainsKey(ConfigFileConstants.ScriptsToProcess))
{
ValidatePS1OrPSM1Extension(ConfigFileConstants.ScriptsToProcess, DISCPowerShellConfiguration.TryGetStringArray(table[ConfigFileConstants.ScriptsToProcess]), filePath);
}
}
/// <summary>
/// Checks if all paths are absolute paths.
/// </summary>
/// <param name="state"></param>
/// <param name="table"></param>
/// <param name="filePath"></param>
internal static void ValidateAbsolutePaths(SessionState state, Hashtable table, string filePath)
{
if (table.ContainsKey(ConfigFileConstants.TypesToProcess))
{
ValidateAbsolutePath(state, ConfigFileConstants.TypesToProcess, DISCPowerShellConfiguration.TryGetStringArray(table[ConfigFileConstants.TypesToProcess]), filePath);
}
if (table.ContainsKey(ConfigFileConstants.FormatsToProcess))
{
ValidateAbsolutePath(state, ConfigFileConstants.FormatsToProcess, DISCPowerShellConfiguration.TryGetStringArray(table[ConfigFileConstants.FormatsToProcess]), filePath);
}
if (table.ContainsKey(ConfigFileConstants.ScriptsToProcess))
{
ValidateAbsolutePath(state, ConfigFileConstants.ScriptsToProcess, DISCPowerShellConfiguration.TryGetStringArray(table[ConfigFileConstants.ScriptsToProcess]), filePath);
}
}
/// <summary>
/// Checks if a path is an absolute path.
/// </summary>
/// <param name="key"></param>
/// <param name="state"></param>
/// <param name="paths"></param>
/// <param name="filePath"></param>
internal static void ValidateAbsolutePath(SessionState state, string key, string[] paths, string filePath)
{
if (paths == null)
{
return;
}
string driveName;
foreach (string path in paths)
{
if (!state.Path.IsPSAbsolute(path, out driveName))
{
throw new InvalidOperationException(StringUtil.Format(RemotingErrorIdStrings.DISCPathsMustBeAbsolute, key, path, filePath));
}
}
}
/// <summary>
/// Validates Role Definition hash entries
///
/// RoleDefinitions = @{
/// 'Everyone' = @{
/// 'RoIeCapabilities' = 'Basic' };
/// 'Administrators' = @{
/// 'VisibleCmdlets' = 'Get-Process','Get-Location'; 'VisibleFunctions = 'TabExpansion2' } }
/// </summary>
/// <param name="roleDefinitions"></param>
internal static void ValidateRoleDefinitions(IDictionary roleDefinitions)
{
foreach (var roleKey in roleDefinitions.Keys)
{
if (roleKey is not string)
{
var invalidOperationEx = new PSInvalidOperationException(
string.Format(RemotingErrorIdStrings.InvalidRoleKeyType, roleKey.GetType().FullName));
invalidOperationEx.SetErrorId("InvalidRoleKeyType");
throw invalidOperationEx;
}
//
// Each role capability in the role definition item should contain a hash table with allowed role capability key.
//
IDictionary roleDefinition = roleDefinitions[roleKey] as IDictionary;
if (roleDefinition == null)
{
var invalidOperationEx = new PSInvalidOperationException(
StringUtil.Format(RemotingErrorIdStrings.InvalidRoleValue, roleKey));
invalidOperationEx.SetErrorId("InvalidRoleEntryNotHashtable");
throw invalidOperationEx;
}
foreach (var key in roleDefinition.Keys)
{
// Ensure each role capability key is valid.
string roleCapabilityKey = key as string;
if (roleCapabilityKey == null)
{
var invalidOperationEx = new PSInvalidOperationException(
string.Format(RemotingErrorIdStrings.InvalidRoleCapabilityKeyType, key.GetType().FullName));
invalidOperationEx.SetErrorId("InvalidRoleCapabilityKeyType");
throw invalidOperationEx;
}
if (!s_allowedRoleCapabilityKeys.Contains(roleCapabilityKey))
{
var invalidOperationEx = new PSInvalidOperationException(
string.Format(RemotingErrorIdStrings.InvalidRoleCapabilityKey, roleCapabilityKey));
invalidOperationEx.SetErrorId("InvalidRoleCapabilityKey");
throw invalidOperationEx;
}
}
}
}
}
#endregion
#region DISCPowerShellConfiguration
/// <summary>
/// Creates an initial session state based on the configuration language for PSSC files.
/// </summary>
internal sealed class DISCPowerShellConfiguration : PSSessionConfiguration
{
private readonly string _configFile;
private readonly Hashtable _configHash;
/// <summary>
/// Gets the configuration hashtable that results from parsing the specified configuration file.
/// </summary>
internal Hashtable ConfigHash
{
get { return _configHash; }
}
/// <summary>
/// Creates a new instance of a Declarative Initial Session State Configuration.
/// </summary>
/// <param name="configFile">The path to the .pssc file representing the initial session state.</param>
/// <param name="roleVerifier">
/// The verifier that PowerShell should call to determine if groups in the Role entry apply to the
/// target session. If you have a WindowsPrincipal for a user, for example, create a Function that
/// checks windowsPrincipal.IsInRole().
/// </param>
/// <param name="validateFile">Validate file for supported configuration options.</param>
internal DISCPowerShellConfiguration(
string configFile,
Func<string, bool> roleVerifier,
bool validateFile = false)
{
_configFile = configFile;
roleVerifier ??= static (role) => false;
Runspace backupRunspace = Runspace.DefaultRunspace;
try
{
Runspace.DefaultRunspace = RunspaceFactory.CreateRunspace();
Runspace.DefaultRunspace.Open();
string scriptName;
ExternalScriptInfo script = DISCUtils.GetScriptInfoForFile(Runspace.DefaultRunspace.ExecutionContext,
configFile, out scriptName);
_configHash = DISCUtils.LoadConfigFile(Runspace.DefaultRunspace.ExecutionContext, script);
if (validateFile)
{
DISCFileValidation.ValidateContents(_configHash);
}
MergeRoleRulesIntoConfigHash(roleVerifier);
MergeRoleCapabilitiesIntoConfigHash();
Runspace.DefaultRunspace.Close();
}
catch (PSSecurityException e)
{
string message = StringUtil.Format(RemotingErrorIdStrings.InvalidPSSessionConfigurationFilePath, configFile);
PSInvalidOperationException ioe = new PSInvalidOperationException(message, e);
ioe.SetErrorId("InvalidPSSessionConfigurationFilePath");
throw ioe;
}
finally
{
Runspace.DefaultRunspace = backupRunspace;
}
}
// Takes the "Roles" node in the config hash, and merges all that apply into the base configuration.
private void MergeRoleRulesIntoConfigHash(Func<string, bool> roleVerifier)
{
if (_configHash.ContainsKey(ConfigFileConstants.RoleDefinitions))
{
// Extract the 'Roles' hashtable
IDictionary roleEntry = _configHash[ConfigFileConstants.RoleDefinitions] as IDictionary;
if (roleEntry == null)
{
string message = StringUtil.Format(RemotingErrorIdStrings.InvalidRoleEntry, _configHash["Roles"].GetType().FullName);
PSInvalidOperationException ioe = new PSInvalidOperationException(message);
ioe.SetErrorId("InvalidRoleDefinitionNotHashtable");
throw ioe;
}
// Ensure that role definitions contain valid entries.
DISCUtils.ValidateRoleDefinitions(roleEntry);
// Go through the Roles hashtable
foreach (object role in roleEntry.Keys)
{
// Check if this role applies to the connected user
if (roleVerifier(role.ToString()))
{
// Extract their specific configuration
IDictionary roleCustomizations = roleEntry[role] as IDictionary;
if (roleCustomizations == null)
{
string message = StringUtil.Format(RemotingErrorIdStrings.InvalidRoleValue, role.ToString());
PSInvalidOperationException ioe = new PSInvalidOperationException(message);
ioe.SetErrorId("InvalidRoleValueNotHashtable");
throw ioe;
}
MergeConfigHashIntoConfigHash(roleCustomizations);
}
}
}
}
// Takes the "RoleCapabilities" node in the config hash, and merges its values into the base configuration.
private const string PSRCExtension = ".psrc";
private void MergeRoleCapabilitiesIntoConfigHash()
{
List<string> psrcFiles = new List<string>();
if (_configHash.ContainsKey(ConfigFileConstants.RoleCapabilities))
{
string[] roleCapabilities = TryGetStringArray(_configHash[ConfigFileConstants.RoleCapabilities]);
if (roleCapabilities != null)
{
foreach (string roleCapability in roleCapabilities)
{
string roleCapabilityPath = GetRoleCapabilityPath(roleCapability);
if (string.IsNullOrEmpty(roleCapabilityPath))
{
string message = StringUtil.Format(RemotingErrorIdStrings.CouldNotFindRoleCapability, roleCapability, roleCapability + PSRCExtension);
PSInvalidOperationException ioe = new PSInvalidOperationException(message);
ioe.SetErrorId("CouldNotFindRoleCapability");
throw ioe;
}
psrcFiles.Add(roleCapabilityPath);
}
}
}
if (ConfigHash.ContainsKey(ConfigFileConstants.RoleCapabilityFiles))
{
string[] roleCapabilityFiles = TryGetStringArray(ConfigHash[ConfigFileConstants.RoleCapabilityFiles]);
if (roleCapabilityFiles != null)
{
foreach (var roleCapabilityFilePath in roleCapabilityFiles)
{
if (!Path.GetExtension(roleCapabilityFilePath).Equals(PSRCExtension, StringComparison.OrdinalIgnoreCase))
{
string message = StringUtil.Format(RemotingErrorIdStrings.InvalidRoleCapabilityFileExtension, roleCapabilityFilePath);
PSInvalidOperationException ioe = new PSInvalidOperationException(message);
ioe.SetErrorId("InvalidRoleCapabilityFileExtension");
throw ioe;
}
if (!File.Exists(roleCapabilityFilePath))
{
string message = StringUtil.Format(RemotingErrorIdStrings.CouldNotFindRoleCapabilityFile, roleCapabilityFilePath);
PSInvalidOperationException ioe = new PSInvalidOperationException(message);
ioe.SetErrorId("CouldNotFindRoleCapabilityFile");
throw ioe;
}
psrcFiles.Add(roleCapabilityFilePath);
}
}
}
foreach (var roleCapabilityFile in psrcFiles)
{
DISCPowerShellConfiguration roleCapabilityConfiguration = new DISCPowerShellConfiguration(roleCapabilityFile, null);
IDictionary roleCapabilityConfigurationItems = roleCapabilityConfiguration.ConfigHash;
MergeConfigHashIntoConfigHash(roleCapabilityConfigurationItems);
}
}
// Merge a role / role capability hashtable into the master configuration hashtable
private void MergeConfigHashIntoConfigHash(IDictionary childConfigHash)
{
foreach (object customization in childConfigHash.Keys)
{
string customizationString = customization.ToString();
var customizationValue = new List<object>();
// First, take all values from the master config table
if (_configHash.ContainsKey(customizationString))
{
IEnumerable existingValueAsCollection = LanguagePrimitives.GetEnumerable(_configHash[customization]);
if (existingValueAsCollection != null)
{
foreach (object value in existingValueAsCollection)
{
customizationValue.Add(value);
}
}
else
{
customizationValue.Add(_configHash[customization]);
}
}
// Then add the current role's values
IEnumerable newValueAsCollection = LanguagePrimitives.GetEnumerable(childConfigHash[customization]);
if (newValueAsCollection != null)
{
foreach (object value in newValueAsCollection)
{
customizationValue.Add(value);
}
}
else
{
customizationValue.Add(childConfigHash[customization]);
}
// Now update the config table for this role.
_configHash[customization] = customizationValue.ToArray();
}
}
private static string GetRoleCapabilityPath(string roleCapability)
{
string moduleName = "*";
if (roleCapability.Contains('\\'))
{
string[] components = roleCapability.Split('\\', 2);
moduleName = components[0];
roleCapability = components[1];
}
// Go through each directory in the module path
string[] modulePaths = ModuleIntrinsics.GetModulePath().Split(Path.PathSeparator);
foreach (string path in modulePaths)
{
try
{
// And then each module in that directory
foreach (string directory in Directory.EnumerateDirectories(path, moduleName))
{
string roleCapabilitiesPath = Path.Combine(directory, "RoleCapabilities");
if (Directory.Exists(roleCapabilitiesPath))
{
// If the role capabilities directory exists, look for .psrc files with the role capability name
foreach (string roleCapabilityPath in Directory.EnumerateFiles(roleCapabilitiesPath, roleCapability + ".psrc"))
{
return roleCapabilityPath;
}
}
}
}
catch (IOException)
{
// Could not enumerate the directories for a broken module path element. Just try the next.
}
catch (UnauthorizedAccessException)
{
// Could not enumerate the directories for a broken module path element. Just try the next.
}
}
return null;
}
/// <summary>
/// Creates an initial session state from a configuration file (DISC)
/// </summary>
/// <param name="senderInfo"></param>
/// <returns></returns>
public override InitialSessionState GetInitialSessionState(PSSenderInfo senderInfo)
{
InitialSessionState iss = null;
// Create the initial session state
string initialSessionState = TryGetValue(_configHash, ConfigFileConstants.SessionType);
SessionType sessionType = SessionType.Default;
bool cmdletVisibilityApplied = IsNonDefaultVisibilitySpecified(ConfigFileConstants.VisibleCmdlets);
bool functionVisibilityApplied = IsNonDefaultVisibilitySpecified(ConfigFileConstants.VisibleFunctions);
bool aliasVisibilityApplied = IsNonDefaultVisibilitySpecified(ConfigFileConstants.VisibleAliases);
bool providerVisibilityApplied = IsNonDefaultVisibilitySpecified(ConfigFileConstants.VisibleProviders);
bool processDefaultSessionStateVisibility = false;
if (!string.IsNullOrEmpty(initialSessionState))
{
sessionType = (SessionType)Enum.Parse(typeof(SessionType), initialSessionState, true);
if (sessionType == SessionType.Empty)
{
iss = InitialSessionState.Create();
}
else if (sessionType == SessionType.RestrictedRemoteServer)
{
iss = InitialSessionState.CreateRestricted(SessionCapabilities.RemoteServer);
}
else
{
iss = InitialSessionState.CreateDefault2();
processDefaultSessionStateVisibility = true;
}
}
else
{
iss = InitialSessionState.CreateDefault2();
processDefaultSessionStateVisibility = true;
}
if (cmdletVisibilityApplied || functionVisibilityApplied || aliasVisibilityApplied || providerVisibilityApplied ||
IsNonDefaultVisibilitySpecified(ConfigFileConstants.VisibleExternalCommands))
{
iss.DefaultCommandVisibility = SessionStateEntryVisibility.Private;
// If visibility is applied on a default runspace then set initial ISS
// commands visibility to private.
if (processDefaultSessionStateVisibility)
{
foreach (var cmd in iss.Commands)
{
cmd.Visibility = iss.DefaultCommandVisibility;
}
}
}
// Add providers
if (providerVisibilityApplied)
{
string[] providers = TryGetStringArray(_configHash[ConfigFileConstants.VisibleProviders]);
if (providers != null)
{
System.Collections.Generic.HashSet<string> addedProviders = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
foreach (string provider in providers)
{
if (!string.IsNullOrEmpty(provider))
{
// Look up providers from provider name including wildcards.
var providersFound = iss.Providers.LookUpByName(provider);
foreach (var providerFound in providersFound)
{
if (!addedProviders.Contains(providerFound.Name))
{
addedProviders.Add(providerFound.Name);
providerFound.Visibility = SessionStateEntryVisibility.Public;
}
}
}
}
}
}
// Add assemblies and modules);
if (_configHash.ContainsKey(ConfigFileConstants.AssembliesToLoad))
{
string[] assemblies = TryGetStringArray(_configHash[ConfigFileConstants.AssembliesToLoad]);
if (assemblies != null)
{
foreach (string assembly in assemblies)
{
iss.Assemblies.Add(new SessionStateAssemblyEntry(assembly));
}
}
}
if (_configHash.ContainsKey(ConfigFileConstants.ModulesToImport))
{
object[] modules = TryGetObjectsOfType<object>(_configHash[ConfigFileConstants.ModulesToImport],
new Type[] { typeof(string), typeof(Hashtable) });
if ((_configHash[ConfigFileConstants.ModulesToImport] != null) && (modules == null))
{
string message = StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeStringOrHashtableArray,
ConfigFileConstants.ModulesToImport);
PSInvalidOperationException ioe = new PSInvalidOperationException(message);
ioe.SetErrorId("InvalidModulesToImportKeyEntries");
throw ioe;
}
if (modules != null)
{
Collection<ModuleSpecification> modulesToImport = new Collection<ModuleSpecification>();
foreach (object module in modules)
{
ModuleSpecification moduleSpec = null;
string moduleName = module as string;
if (!string.IsNullOrEmpty(moduleName))
{
moduleSpec = new ModuleSpecification(moduleName);
}
else
{
Hashtable moduleHash = module as Hashtable;
if (moduleHash != null)
{
moduleSpec = new ModuleSpecification(moduleHash);
}
}
// Now add the moduleSpec to modulesToImport
if (moduleSpec != null)
{
if (string.Equals(InitialSessionState.CoreModule, moduleSpec.Name,
StringComparison.OrdinalIgnoreCase))
{
if (sessionType == SessionType.Empty)
{
// Win8: 627752 Cannot load microsoft.powershell.core module as part of DISC
// Convert Microsoft.PowerShell.Core module -> Microsoft.PowerShell.Core snapin.
// Doing this Import only in SessionType.Empty case, because other cases already do this.
// In V3, Microsoft.PowerShell.Core module is not installed externally.
iss.ImportCorePSSnapIn();
}
// silently ignore Microsoft.PowerShell.Core for other cases ie., SessionType.RestrictedRemoteServer && SessionType.Default
}
else
{
modulesToImport.Add(moduleSpec);
}
}
}
iss.ImportPSModule(modulesToImport);
}
}
// Define members
if (_configHash.ContainsKey(ConfigFileConstants.VisibleCmdlets))
{
object[] cmdlets = TryGetObjectsOfType<object>(_configHash[ConfigFileConstants.VisibleCmdlets],
new Type[] { typeof(string), typeof(Hashtable) });
if (cmdlets == null)
{
string message = StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeStringOrHashtableArray,
ConfigFileConstants.VisibleCmdlets);
PSInvalidOperationException ioe = new PSInvalidOperationException(message);
ioe.SetErrorId("InvalidVisibleCmdletsKeyEntries");
throw ioe;
}
ProcessVisibleCommands(iss, cmdlets);
}
if (_configHash.ContainsKey(ConfigFileConstants.AliasDefinitions))
{
Hashtable[] aliases = TryGetHashtableArray(_configHash[ConfigFileConstants.AliasDefinitions]);
if (aliases != null)
{
foreach (Hashtable alias in aliases)
{
SessionStateAliasEntry entry = CreateSessionStateAliasEntry(alias, aliasVisibilityApplied);
if (entry != null)
{
// Indexing iss.Commands with a command that does not exist returns 'null', rather
// than some sort of KeyNotFound exception.
if (iss.Commands[entry.Name] != null)
{
iss.Commands.Remove(entry.Name, typeof(SessionStateAliasEntry));
}
iss.Commands.Add(entry);
}
}
}
}
if (_configHash.ContainsKey(ConfigFileConstants.VisibleAliases))
{
string[] aliases = DISCPowerShellConfiguration.TryGetStringArray(_configHash[ConfigFileConstants.VisibleAliases]);
if (aliases != null)
{
foreach (string alias in aliases)
{
if (!string.IsNullOrEmpty(alias))
{
bool found = false;
// Look up aliases using alias name including wildcards.
Collection<SessionStateCommandEntry> existingEntries = iss.Commands.LookUpByName(alias);
foreach (SessionStateCommandEntry existingEntry in existingEntries)
{
if (existingEntry.CommandType == CommandTypes.Alias)
{
existingEntry.Visibility = SessionStateEntryVisibility.Public;
found = true;
}
}
if (!found || WildcardPattern.ContainsWildcardCharacters(alias))
{
iss.UnresolvedCommandsToExpose.Add(alias);
}
}
}
}
}
if (_configHash.ContainsKey(ConfigFileConstants.FunctionDefinitions))
{
Hashtable[] functions = TryGetHashtableArray(_configHash[ConfigFileConstants.FunctionDefinitions]);
if (functions != null)
{
foreach (Hashtable function in functions)
{
SessionStateFunctionEntry entry = CreateSessionStateFunctionEntry(function, functionVisibilityApplied);
if (entry != null)
{
iss.Commands.Add(entry);
}
}
}
}
if (_configHash.ContainsKey(ConfigFileConstants.VisibleFunctions))
{
object[] functions = TryGetObjectsOfType<object>(_configHash[ConfigFileConstants.VisibleFunctions],
new Type[] { typeof(string), typeof(Hashtable) });
if (functions == null)
{
string message = StringUtil.Format(RemotingErrorIdStrings.DISCTypeMustBeStringOrHashtableArray,
ConfigFileConstants.VisibleFunctions);
PSInvalidOperationException ioe = new PSInvalidOperationException(message);
ioe.SetErrorId("InvalidVisibleFunctionsKeyEntries");
throw ioe;
}
ProcessVisibleCommands(iss, functions);
}
if (_configHash.ContainsKey(ConfigFileConstants.VariableDefinitions))
{
Hashtable[] variables = TryGetHashtableArray(_configHash[ConfigFileConstants.VariableDefinitions]);
if (variables != null)
{
foreach (Hashtable variable in variables)
{
if (variable.ContainsKey(ConfigFileConstants.VariableValueToken) &&
variable[ConfigFileConstants.VariableValueToken] is ScriptBlock)
{
iss.DynamicVariablesToDefine.Add(variable);
continue;
}
SessionStateVariableEntry entry = CreateSessionStateVariableEntry(variable, iss.LanguageMode);
if (entry != null)
{
iss.Variables.Add(entry);
}
}
}
}
if (_configHash.ContainsKey(ConfigFileConstants.EnvironmentVariables))
{
Hashtable[] variablesList = TryGetHashtableArray(_configHash[ConfigFileConstants.EnvironmentVariables]);
if (variablesList != null)
{
foreach (Hashtable variables in variablesList)
{
foreach (DictionaryEntry variable in variables)
{
SessionStateVariableEntry entry = new SessionStateVariableEntry(variable.Key.ToString(), variable.Value.ToString(), null);
iss.EnvironmentVariables.Add(entry);
}
}
}
}
// Update type data
if (_configHash.ContainsKey(ConfigFileConstants.TypesToProcess))
{
string[] types = DISCPowerShellConfiguration.TryGetStringArray(_configHash[ConfigFileConstants.TypesToProcess]);
if (types != null)
{
foreach (string type in types)
{
if (!string.IsNullOrEmpty(type))
{
iss.Types.Add(new SessionStateTypeEntry(type));
}
}
}
}
// Update format data
if (_configHash.ContainsKey(ConfigFileConstants.FormatsToProcess))
{
string[] formats = DISCPowerShellConfiguration.TryGetStringArray(_configHash[ConfigFileConstants.FormatsToProcess]);
if (formats != null)
{
foreach (string format in formats)
{
if (!string.IsNullOrEmpty(format))
{
iss.Formats.Add(new SessionStateFormatEntry(format));
}
}
}
}
// Add external commands
if (_configHash.ContainsKey(ConfigFileConstants.VisibleExternalCommands))
{
string[] externalCommands = TryGetStringArray(_configHash[ConfigFileConstants.VisibleExternalCommands]);
if (externalCommands != null)
{
foreach (string command in externalCommands)
{
if (command.EndsWith(".ps1", StringComparison.OrdinalIgnoreCase))
{
iss.Commands.Add(
new SessionStateScriptEntry(command, SessionStateEntryVisibility.Public));
}
else
{
if (command == "*")
{
iss.Commands.Add(
new SessionStateScriptEntry(command, SessionStateEntryVisibility.Public));
}
iss.Commands.Add(
new SessionStateApplicationEntry(command, SessionStateEntryVisibility.Public));
}
}
}
}
// Register startup scripts
if (_configHash.ContainsKey(ConfigFileConstants.ScriptsToProcess))
{
string[] startupScripts = DISCPowerShellConfiguration.TryGetStringArray(_configHash[ConfigFileConstants.ScriptsToProcess]);
if (startupScripts != null)
{
foreach (string script in startupScripts)
{
if (!string.IsNullOrEmpty(script))
{
iss.StartupScripts.Add(script);
}
}
}
}
// Now apply visibility logic
if (cmdletVisibilityApplied || functionVisibilityApplied || aliasVisibilityApplied || providerVisibilityApplied)
{
if (sessionType == SessionType.Default)
{
// autoloading preference is none, so modules cannot be autoloaded. Since the session type is default,
// load PowerShell default modules
iss.ImportPSCoreModule(InitialSessionState.EngineModules.ToArray());
}
if (cmdletVisibilityApplied)
{
// Import-Module is needed for internal *required modules* processing, so make visibility private.
var importModuleEntry = iss.Commands["Import-Module"];
if (importModuleEntry.Count == 1)
{
importModuleEntry[0].Visibility = SessionStateEntryVisibility.Private;
}
}
if (aliasVisibilityApplied)
{
// Import-Module is needed for internal *required modules* processing, so make visibility private.
var importModuleAliasEntry = iss.Commands["ipmo"];
if (importModuleAliasEntry.Count == 1)
{
importModuleAliasEntry[0].Visibility = SessionStateEntryVisibility.Private;
}
}
iss.DefaultCommandVisibility = SessionStateEntryVisibility.Private;
iss.Variables.Add(new SessionStateVariableEntry(SpecialVariables.PSModuleAutoLoading, PSModuleAutoLoadingPreference.None, string.Empty, ScopedItemOptions.None));
}
// Set the execution policy
if (_configHash.ContainsKey(ConfigFileConstants.ExecutionPolicy))
{
Microsoft.PowerShell.ExecutionPolicy executionPolicy = (Microsoft.PowerShell.ExecutionPolicy)Enum.Parse(
typeof(Microsoft.PowerShell.ExecutionPolicy), _configHash[ConfigFileConstants.ExecutionPolicy].ToString(), true);
iss.ExecutionPolicy = executionPolicy;
}
// Set the language mode
if (_configHash.ContainsKey(ConfigFileConstants.LanguageMode))
{
System.Management.Automation.PSLanguageMode languageMode = (System.Management.Automation.PSLanguageMode)Enum.Parse(
typeof(System.Management.Automation.PSLanguageMode), _configHash[ConfigFileConstants.LanguageMode].ToString(), true);
iss.LanguageMode = languageMode;
}
// Set the transcript directory
if (_configHash.ContainsKey(ConfigFileConstants.TranscriptDirectory))
{
iss.TranscriptDirectory = _configHash[ConfigFileConstants.TranscriptDirectory].ToString();
}
// Process User Drive
if (_configHash.ContainsKey(ConfigFileConstants.MountUserDrive))
{
if (Convert.ToBoolean(_configHash[ConfigFileConstants.MountUserDrive], CultureInfo.InvariantCulture))
{
iss.UserDriveEnabled = true;
iss.UserDriveUserName = senderInfo?.UserInfo.Identity.Name;
// Set user drive max drive if provided.
if (_configHash.ContainsKey(ConfigFileConstants.UserDriveMaxSize))
{
long userDriveMaxSize = Convert.ToInt64(_configHash[ConfigFileConstants.UserDriveMaxSize]);
if (userDriveMaxSize > 0)
{
iss.UserDriveMaximumSize = userDriveMaxSize;
}
}
// Input parameter validation enforcement is always true when a User drive is created.
iss.EnforceInputParameterValidation = true;
// Add function definitions for Copy-Item support.
ProcessCopyItemFunctionDefinitions(iss);
}
}
return iss;
}
// Adds Copy-Item remote session helper functions to the ISS.
private static void ProcessCopyItemFunctionDefinitions(InitialSessionState iss)
{
// Copy file to remote helper functions.
foreach (var copyToRemoteFn in CopyFileRemoteUtils.GetAllCopyToRemoteScriptFunctions())
{
var functionEntry = new SessionStateFunctionEntry(
copyToRemoteFn["Name"] as string,
copyToRemoteFn["Definition"] as string);
iss.Commands.Add(functionEntry);
}
// Copy file from remote helper functions.
foreach (var copyFromRemoteFn in CopyFileRemoteUtils.GetAllCopyFromRemoteScriptFunctions())
{
var functionEntry = new SessionStateFunctionEntry(
copyFromRemoteFn["Name"] as string,
copyFromRemoteFn["Definition"] as string);
iss.Commands.Add(functionEntry);
}
}
private static void ProcessVisibleCommands(InitialSessionState iss, object[] commands)
{
// A dictionary of: function name -> Parameters
// Parameters = A dictionary of parameter names -> Modifications
// Modifications = A dictionary of modification types (ValidatePattern, ValidateSet) to the interim value
// for that attribute, as a HashSet of strings. For ValidateSet, this will be used as a collection of strings
// directly during proxy generation. For ValidatePattern, it will be combined into a regex
// like: '^(Pattern1|Pattern2|Pattern3)$' during proxy generation.
Dictionary<string, Hashtable> commandModifications = new Dictionary<string, Hashtable>(StringComparer.OrdinalIgnoreCase);
// Create a hash set of current modules to import so that fully qualified commands can include their
// module if needed.
HashSet<string> commandModuleNames = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
foreach (var moduleSpec in iss.ModuleSpecificationsToImport)
{
commandModuleNames.Add(moduleSpec.Name);
}
foreach (object commandObject in commands)
{
if (commandObject == null)
{
continue;
}
// If it's just a string, this is a visible command
string command = commandObject as string;
if (!string.IsNullOrEmpty(command))
{
ProcessVisibleCommand(iss, command, commandModuleNames);
}
else
{
// If it's a hashtable, it represents a customization to a cmdlet.
// (I.e.: Exposed parameter with ValidateSet and / or ValidatePattern)
// Collect these so that we can post-process them.
IDictionary commandModification = commandObject as IDictionary;
if (commandModification != null)
{
ProcessCommandModification(commandModifications, commandModification);
}
}
}
// Now, save the commandModifications table for post-processing during runspace creation,
// where we have the command info
foreach (var pair in commandModifications)
{
iss.CommandModifications.Add(pair.Key, pair.Value);
}
}
private static void ProcessCommandModification(Dictionary<string, Hashtable> commandModifications, IDictionary commandModification)
{
string commandName = commandModification["Name"] as string;
Hashtable[] parameters = null;
if (commandModification.Contains("Parameters"))
{
parameters = TryGetHashtableArray(commandModification["Parameters"]);
if (parameters != null)
{
// Validate that the parameter restriction has the right keys
foreach (Hashtable parameter in parameters)
{
if (!parameter.ContainsKey("Name"))
{
parameters = null;
break;
}
}
}
}
// Validate that we got the Name and Parameters keys
if ((commandName == null) || (parameters == null))
{
string hashtableKey = commandName;
if (string.IsNullOrEmpty(hashtableKey))
{
IEnumerator errorKey = commandModification.Keys.GetEnumerator();
errorKey.MoveNext();
hashtableKey = errorKey.Current.ToString();
}
string message = StringUtil.Format(RemotingErrorIdStrings.DISCCommandModificationSyntax, hashtableKey);
PSInvalidOperationException ioe = new PSInvalidOperationException(message);
ioe.SetErrorId("InvalidVisibleCommandKeyEntries");
throw ioe;
}
// Ensure we have the hashtable representing the current command being modified
Hashtable parameterModifications;
if (!commandModifications.TryGetValue(commandName, out parameterModifications))
{
parameterModifications = new Hashtable(StringComparer.OrdinalIgnoreCase);
commandModifications[commandName] = parameterModifications;
}
foreach (IDictionary parameter in parameters)
{
// Ensure we have the hashtable representing the current parameter being modified
string parameterName = parameter["Name"].ToString();
Hashtable currentParameterModification = parameterModifications[parameterName] as Hashtable;
if (currentParameterModification == null)
{
currentParameterModification = new Hashtable(StringComparer.OrdinalIgnoreCase);
parameterModifications[parameterName] = currentParameterModification;
}
foreach (string parameterModification in parameter.Keys)
{
if (string.Equals("Name", parameterModification, StringComparison.OrdinalIgnoreCase))
{
continue;
}
// Go through the keys, adding them to the current parameter modification
if (!currentParameterModification.Contains(parameterModification))
{
currentParameterModification[parameterModification] = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
}
HashSet<string> currentParameterModificationValue = (HashSet<string>)currentParameterModification[parameterModification];
foreach (string parameterModificationValue in TryGetStringArray(parameter[parameterModification]))
{
if (!string.IsNullOrEmpty(parameterModificationValue))
{
currentParameterModificationValue.Add(parameterModificationValue);
}
}
}
}
}
private static void ProcessVisibleCommand(InitialSessionState iss, string command, HashSet<string> moduleNames)
{
bool found = false;
// Defer module restricted command processing to runspace bind time.
// Module restricted command names are fully qualified with the module name:
// <ModuleName>\<CommandName>, e.g., PSScheduledJob\*JobTrigger*
if (command.IndexOf('\\') < 0)
{
// Look up commands from command name including wildcards.
Collection<SessionStateCommandEntry> existingEntries = iss.Commands.LookUpByName(command);
foreach (SessionStateCommandEntry existingEntry in existingEntries)
{
if ((existingEntry.CommandType == CommandTypes.Cmdlet) || (existingEntry.CommandType == CommandTypes.Function))
{
existingEntry.Visibility = SessionStateEntryVisibility.Public;
found = true;
}
}
}
else
{
// Extract the module name and ensure it is part of the ISS modules to process list.
string moduleName;
Utils.ParseCommandName(command, out moduleName);
if (!string.IsNullOrEmpty(moduleName) && !moduleNames.Contains(moduleName))
{
moduleNames.Add(moduleName);
iss.ImportPSModule(new string[] { moduleName });
}
}
if (!found || WildcardPattern.ContainsWildcardCharacters(command))
{
iss.UnresolvedCommandsToExpose.Add(command);
}
}
/// <summary>
/// Creates an alias entry.
/// </summary>
private static SessionStateAliasEntry CreateSessionStateAliasEntry(Hashtable alias, bool isAliasVisibilityDefined)
{
string name = TryGetValue(alias, ConfigFileConstants.AliasNameToken);
if (string.IsNullOrEmpty(name))
{
return null;
}
string value = TryGetValue(alias, ConfigFileConstants.AliasValueToken);
if (string.IsNullOrEmpty(value))
{
return null;
}
string description = TryGetValue(alias, ConfigFileConstants.AliasDescriptionToken);
ScopedItemOptions options = ScopedItemOptions.None;
string optionsString = TryGetValue(alias, ConfigFileConstants.AliasOptionsToken);
if (!string.IsNullOrEmpty(optionsString))
{
options = (ScopedItemOptions)Enum.Parse(typeof(ScopedItemOptions), optionsString, true);
}
SessionStateEntryVisibility visibility = SessionStateEntryVisibility.Private;
if (!isAliasVisibilityDefined)
{
visibility = SessionStateEntryVisibility.Public;
}
return new SessionStateAliasEntry(name, value, description, options, visibility);
}
/// <summary>
/// Creates a function entry.
/// </summary>
/// <returns></returns>
private static SessionStateFunctionEntry CreateSessionStateFunctionEntry(Hashtable function, bool isFunctionVisibilityDefined)
{
string name = TryGetValue(function, ConfigFileConstants.FunctionNameToken);
if (string.IsNullOrEmpty(name))
{
return null;
}
string value = TryGetValue(function, ConfigFileConstants.FunctionValueToken);
if (string.IsNullOrEmpty(value))
{
return null;
}
ScopedItemOptions options = ScopedItemOptions.None;
string optionsString = TryGetValue(function, ConfigFileConstants.FunctionOptionsToken);
if (!string.IsNullOrEmpty(optionsString))
{
options = (ScopedItemOptions)Enum.Parse(typeof(ScopedItemOptions), optionsString, true);
}
ScriptBlock newFunction = ScriptBlock.Create(value);
newFunction.LanguageMode = PSLanguageMode.FullLanguage;
SessionStateEntryVisibility functionVisibility = SessionStateEntryVisibility.Private;
if (!isFunctionVisibilityDefined)
{
functionVisibility = SessionStateEntryVisibility.Public;
}
return new SessionStateFunctionEntry(name, value, options, functionVisibility, newFunction, null);
}
/// <summary>
/// Creates a variable entry.
/// </summary>
private static SessionStateVariableEntry CreateSessionStateVariableEntry(Hashtable variable, PSLanguageMode languageMode)
{
string name = TryGetValue(variable, ConfigFileConstants.VariableNameToken);
if (string.IsNullOrEmpty(name))
{
return null;
}
string value = TryGetValue(variable, ConfigFileConstants.VariableValueToken);
if (string.IsNullOrEmpty(value))
{
return null;
}
string description = TryGetValue(variable, ConfigFileConstants.AliasDescriptionToken);
ScopedItemOptions options = ScopedItemOptions.None;
string optionsString = TryGetValue(variable, ConfigFileConstants.AliasOptionsToken);
if (!string.IsNullOrEmpty(optionsString))
{
options = (ScopedItemOptions)Enum.Parse(typeof(ScopedItemOptions), optionsString, true);
}
SessionStateEntryVisibility visibility = SessionStateEntryVisibility.Private;
if (languageMode == PSLanguageMode.FullLanguage)
{
visibility = SessionStateEntryVisibility.Public;
}
return new SessionStateVariableEntry(name, value, description, options, new Collections.ObjectModel.Collection<Attribute>(), visibility);
}
/// <summary>
/// Applies the command (cmdlet/function/alias) visibility settings to the <paramref name="iss"/>
/// </summary>
/// <param name="configFileKey"></param>
/// <returns></returns>
private bool IsNonDefaultVisibilitySpecified(string configFileKey)
{
if (_configHash.ContainsKey(configFileKey))
{
string[] commands =
DISCPowerShellConfiguration.TryGetStringArray(_configHash[configFileKey]);
if ((commands == null) || (commands.Length == 0))
{
return false;
}
return true;
}
return false;
}
/// <summary>
/// Attempts to get a value from a hashtable.
/// </summary>
/// <param name="table"></param>
/// <param name="key"></param>
/// <returns></returns>
internal static string TryGetValue(Hashtable table, string key)
{
if (table.ContainsKey(key))
{
return table[key].ToString();
}
return string.Empty;
}
/// <summary>
/// Attempts to get a hashtable array from an object.
/// </summary>
/// <param name="hashObj"></param>
/// <returns></returns>
internal static Hashtable[] TryGetHashtableArray(object hashObj)
{
// Scalar case
Hashtable hashtable = hashObj as Hashtable;
if (hashtable != null)
{
return new[] { hashtable };
}
// 1. Direct conversion
Hashtable[] hashArray = hashObj as Hashtable[];
if (hashArray == null)
{
// 2. Convert from object array
object[] objArray = hashObj as object[];
if (objArray != null)
{
hashArray = new Hashtable[objArray.Length];
for (int i = 0; i < hashArray.Length; i++)
{
if (objArray[i] is not Hashtable hash)
{
return null;
}
hashArray[i] = hash;
}
}
}
return hashArray;
}
/// <summary>
/// Attempts to get a string array from a hashtable.
/// </summary>
/// <param name="hashObj"></param>
/// <returns></returns>
internal static string[] TryGetStringArray(object hashObj)
{
object[] objs = hashObj as object[];
if (objs == null)
{
// Scalar case
object obj = hashObj as object;
if (obj != null)
{
return new string[] { obj.ToString() };
}
else
{
return null;
}
}
string[] result = new string[objs.Length];
for (int i = 0; i < objs.Length; i++)
{
result[i] = objs[i].ToString();
}
return result;
}
internal static T[] TryGetObjectsOfType<T>(object hashObj, IEnumerable<Type> types) where T : class
{
object[] objs = hashObj as object[];
if (objs == null)
{
// Scalar case
object obj = hashObj;
if (obj != null)
{
foreach (Type type in types)
{
if (obj.GetType().Equals(type))
{
return new T[] { obj as T };
}
}
}
return null;
}
T[] result = new T[objs.Length];
for (int i = 0; i < objs.Length; i++)
{
int i1 = i;
if (types.Any(type => objs[i1].GetType().Equals(type)))
{
result[i] = objs[i] as T;
}
else
{
return null;
}
}
return result;
}
}
#endregion
#region DISCFileValidation
internal static class DISCFileValidation
{
// Set of supported configuration options for a PowerShell InitialSessionState.
#if UNIX
private static readonly HashSet<string> SupportedConfigOptions = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
{
"AliasDefinitions",
"AssembliesToLoad",
"Author",
"CompanyName",
"Copyright",
"Description",
"EnvironmentVariables",
"FormatsToProcess",
"FunctionDefinitions",
"GUID",
"LanguageMode",
"ModulesToImport",
"MountUserDrive",
"SchemaVersion",
"ScriptsToProcess",
"SessionType",
"TranscriptDirectory",
"TypesToProcess",
"UserDriveMaximumSize",
"VisibleAliases",
"VisibleCmdlets",
"VariableDefinitions",
"VisibleExternalCommands",
"VisibleFunctions",
"VisibleProviders"
};
#else
private static readonly HashSet<string> SupportedConfigOptions = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
{
"AliasDefinitions",
"AssembliesToLoad",
"Author",
"CompanyName",
"Copyright",
"Description",
"EnvironmentVariables",
"ExecutionPolicy",
"FormatsToProcess",
"FunctionDefinitions",
"GUID",
"LanguageMode",
"ModulesToImport",
"MountUserDrive",
"SchemaVersion",
"ScriptsToProcess",
"SessionType",
"TranscriptDirectory",
"TypesToProcess",
"UserDriveMaximumSize",
"VisibleAliases",
"VisibleCmdlets",
"VariableDefinitions",
"VisibleExternalCommands",
"VisibleFunctions",
"VisibleProviders"
};
#endif
// These are configuration options for WSMan (WinRM) endpoint configurations, that
// appear in .pssc files, but are not part of PowerShell InitialSessionState.
private static readonly HashSet<string> UnsupportedConfigOptions = new HashSet<string>(StringComparer.OrdinalIgnoreCase)
{
"GroupManagedServiceAccount",
"PowerShellVersion",
"RequiredGroups",
"RoleDefinitions",
"RunAsVirtualAccount",
"RunAsVirtualAccountGroups"
};
internal static void ValidateContents(Hashtable configHash)
{
foreach (var key in configHash.Keys)
{
if (key is not string keyName)
{
throw new PSInvalidOperationException(RemotingErrorIdStrings.DISCInvalidConfigKeyType);
}
if (UnsupportedConfigOptions.Contains(keyName))
{
throw new PSInvalidOperationException(
StringUtil.Format(RemotingErrorIdStrings.DISCUnsupportedConfigName, keyName));
}
if (!SupportedConfigOptions.Contains(keyName))
{
throw new PSInvalidOperationException(
StringUtil.Format(RemotingErrorIdStrings.DISCUnknownConfigName, keyName));
}
}
}
}
#endregion
#endregion
}
|