/usr/share/perl5/Net/OpenSSH.pm is in libnet-openssh-perl 0.74-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 | package Net::OpenSSH;
our $VERSION = '0.74';
use strict;
use warnings;
our $debug ||= 0;
our $debug_fh ||= \*STDERR;
our $FACTORY;
use Carp qw(carp croak);
use POSIX qw(:sys_wait_h);
use Socket;
use File::Spec;
use Cwd ();
use Scalar::Util ();
use Errno ();
use Net::OpenSSH::Constants qw(:error :_state);
use Net::OpenSSH::ModuleLoader;
use Net::OpenSSH::ShellQuoter;
my $thread_generation = 0;
sub CLONE { $thread_generation++ };
sub _debug {
local ($!, $@);
print {$debug_fh} '# ', (map { defined($_) ? $_ : '<undef>' } @_), "\n"
}
sub _debug_dump {
local ($!, $@);
require Data::Dumper;
local $Data::Dumper::Terse = 1;
local $Data::Dumper::Indent = 0;
my $head = shift;
_debug("$head: ", Data::Dumper::Dumper(@_));
}
sub _hexdump {
no warnings qw(uninitialized);
my $data = shift;
while ($data =~ /(.{1,32})/smg) {
my $line=$1;
my @c= (( map { sprintf "%02x",$_ } unpack('C*', $line)),
((" ") x 32))[0..31];
$line=~s/(.)/ my $c=$1; unpack("c",$c)>=32 ? $c : '.' /egms;
print {$debug_fh} "#> ", join(" ", @c, '|', $line), "\n";
}
}
{
my %good;
sub _sub_options {
my $sub = shift;
$good{__PACKAGE__ . "::$sub"} = { map { $_ => 1 } @_ };
}
sub _croak_bad_options (\%) {
my $opts = shift;
if (%$opts) {
my $sub = (caller 1)[3];
my $good = $good{$sub};
my @keys = grep defined($opts->{$_}), ( $good ? grep !$good->{$_}, keys %$opts : keys %$opts);
if (@keys) {
croak "Invalid or bad combination of options ('" . CORE::join("', '", @keys) . "')";
}
}
}
}
sub _croak_scalar_context {
my ($sub, $wantarray) = (caller 1)[3, 5];
unless ($wantarray) {
$sub =~ s/^.*:://;
croak "method '$sub' called in scalar context";
}
}
sub _tcroak {
if (${^TAINT} > 0) {
push @_, " while running with -T switch";
goto &croak;
}
if (${^TAINT} < 0) {
push @_, " while running with -t switch";
goto &carp;
}
}
sub _catch_tainted_args {
my $i;
for (@_) {
next unless $i++;
if (Scalar::Util::tainted($_)) {
my (undef, undef, undef, $subn) = caller 1;
my $msg = ( $subn =~ /::([a-z]\w*)$/
? "Insecure argument '$_' on '$1' method call"
: "Insecure argument '$_' on method call" );
_tcroak($msg);
}
elsif (ref($_) eq 'HASH') {
for (grep Scalar::Util::tainted($_), values %$_) {
my (undef, undef, undef, $subn) = caller 1;
my $msg = ( $subn =~ /::([a-z]\w*)$/
? "Insecure argument on '$1' method call"
: "Insecure argument on method call" );
_tcroak($msg);
}
}
}
}
sub _set_error {
my $self = shift;
my $code = shift || 0;
my $err = $self->{_error} = ( $code
? Scalar::Util::dualvar($code, join(': ', @{$self->{_error_prefix}},
(@_ ? @_ : "Unknown error $code")))
: 0 );
$debug and $debug & 1 and _debug "set_error($code - $err)";
return $err
}
my $check_eval_re = do {
my $path = quotemeta $INC{"Net/OpenSSH.pm"};
qr/at $path line \d+.$/
};
sub _check_eval_ok {
my ($self, $code) = @_;
if ($@) {
my $err = $@;
$err =~ s/$check_eval_re//;
$self->_set_error($code, $err);
return;
}
1
}
sub _or_set_error {
my $self = shift;
$self->{_error} or $self->_set_error(@_);
}
sub _first_defined { defined && return $_ for @_; return }
my $obfuscate = sub {
# just for the casual observer...
my $txt = shift;
$txt =~ s/(.)/chr(ord($1) ^ 47)/ges
if defined $txt;
$txt;
};
my $deobfuscate = $obfuscate;
# regexp from Regexp::IPv6
my $IPv6_re = qr((?-xism::(?::[0-9a-fA-F]{1,4}){0,5}(?:(?::[0-9a-fA-F]{1,4}){1,2}|:(?:(?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})))|[0-9a-fA-F]{1,4}:(?:[0-9a-fA-F]{1,4}:(?:[0-9a-fA-F]{1,4}:(?:[0-9a-fA-F]{1,4}:(?:[0-9a-fA-F]{1,4}:(?:[0-9a-fA-F]{1,4}:(?:[0-9a-fA-F]{1,4}:(?:[0-9a-fA-F]{1,4}|:)|(?::(?:[0-9a-fA-F]{1,4})?|(?:(?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2}))))|:(?:(?:(?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2}))|[0-9a-fA-F]{1,4}(?::[0-9a-fA-F]{1,4})?|))|(?::(?:(?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2}))|:[0-9a-fA-F]{1,4}(?::(?:(?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2}))|(?::[0-9a-fA-F]{1,4}){0,2})|:))|(?:(?::[0-9a-fA-F]{1,4}){0,2}(?::(?:(?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2}))|(?::[0-9a-fA-F]{1,4}){1,2})|:))|(?:(?::[0-9a-fA-F]{1,4}){0,3}(?::(?:(?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2}))|(?::[0-9a-fA-F]{1,4}){1,2})|:))|(?:(?::[0-9a-fA-F]{1,4}){0,4}(?::(?:(?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})[.](?:25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2}))|(?::[0-9a-fA-F]{1,4}){1,2})|:))));
sub parse_connection_opts {
my ($class, $opts) = @_;
my ($user, $passwd, $ipv6, $host, $port, $host_squared);
my $target = delete $opts->{host};
defined $target or croak "mandatory host argument missing";
($user, $passwd, $ipv6, $host, $port) =
$target =~ m{^
\s* # space
(?:
([^:]+) # username
(?::(.*))? # : password
\@ # @
)?
(?: # host
( # IPv6...
\[$IPv6_re(?:\%[^\[\]]*)\] # [IPv6]
| # or
$IPv6_re # IPv6
)
| # or
([^\[\]\@:]+) # hostname / ipv4
)
(?::([^\@:]+))? # port
\s* # space
$}ix
or croak "bad host/target '$target' specification";
if (defined $ipv6) {
($host) = $ipv6 =~ /^\[?(.*?)\]?$/;
$host_squared = "[$host]";
}
else {
$host_squared = $host;
}
$user = delete $opts->{user} unless defined $user;
$port = delete $opts->{port} unless defined $port;
$passwd = delete $opts->{passwd} unless defined $passwd;
$passwd = delete $opts->{password} unless defined $passwd;
wantarray and return ($host, $port, $user, $passwd, $host_squared);
my %r = ( user => $user,
password => $passwd,
host => $host,
host_squared => $host_squared,
port => $port );
$r{ipv6} = 1 if defined $ipv6;
return \%r;
}
sub new {
${^TAINT} and &_catch_tainted_args;
my $class = shift;
@_ & 1 and unshift @_, 'host';
return $FACTORY->($class, @_) if defined $FACTORY;
my %opts = @_;
my $external_master = delete $opts{external_master};
# reuse_master is an obsolete alias:
$external_master = delete $opts{reuse_master} unless defined $external_master;
if (not defined $opts{host} and defined $external_master) {
$opts{host} = '0.0.0.0';
}
my ($host, $port, $user, $passwd, $host_squared) = $class->parse_connection_opts(\%opts);
my ($passphrase, $key_path, $login_handler);
unless (defined $passwd) {
$key_path = delete $opts{key_path};
$passwd = delete $opts{passphrase};
if (defined $passwd) {
$passphrase = 1;
}
else {
$login_handler = delete $opts{login_handler};
}
}
my $ssh_version = delete $opts{ssh_version};
my $batch_mode = delete $opts{batch_mode};
my $ctl_path = delete $opts{ctl_path};
my $ctl_dir = delete $opts{ctl_dir};
my $proxy_command = delete $opts{proxy_command};
my $gateway = delete $opts{gateway} unless defined $proxy_command;
my $ssh_cmd = _first_defined delete $opts{ssh_cmd}, 'ssh';
my $rsync_cmd = _first_defined delete $opts{rsync_cmd}, 'rsync';
my $scp_cmd = delete $opts{scp_cmd};
my $sshfs_cmd = _first_defined delete $opts{sshfs_cmd}, 'sshfs';
my $sftp_server_cmd = _first_defined delete $opts{sftp_server_cmd},
'/usr/lib/openssh/sftp-server';
my $timeout = delete $opts{timeout};
my $kill_ssh_on_timeout = delete $opts{kill_ssh_on_timeout};
my $strict_mode = _first_defined delete $opts{strict_mode}, 1;
my $connect = _first_defined delete $opts{connect}, 1;
my $async = delete $opts{async};
my $remote_shell = _first_defined delete $opts{remote_shell}, 'POSIX';
my $expand_vars = delete $opts{expand_vars};
my $vars = _first_defined delete $opts{vars}, {};
my $default_encoding = delete $opts{default_encoding};
my $default_stream_encoding =
_first_defined delete $opts{default_stream_encoding}, $default_encoding;
my $default_argument_encoding =
_first_defined delete $opts{default_argument_encoding}, $default_encoding;
my $forward_agent = delete $opts{forward_agent};
$forward_agent and $passphrase and
croak "agent forwarding can not be used when a passphrase has also been given";
my $forward_X11 = delete $opts{forward_X11};
my $passwd_prompt = delete $opts{password_prompt};
$passwd_prompt = delete $opts{passwd_prompt} unless defined $passwd_prompt;
my ($master_opts, @master_opts,
$master_stdout_fh, $master_stderr_fh,
$master_stdout_discard, $master_stderr_discard,
$master_setpgrp);
unless ($external_master) {
($master_stdout_fh = delete $opts{master_stdout_fh} or
$master_stdout_discard = delete $opts{master_stdout_discard});
($master_stderr_fh = delete $opts{master_stderr_fh} or
$master_stderr_discard = delete $opts{master_stderr_discard});
$master_opts = delete $opts{master_opts};
if (defined $master_opts) {
if (ref $master_opts) {
@master_opts = @$master_opts;
}
else {
carp "'master_opts' argument looks like if it should be splited first"
if $master_opts =~ /^-\w\s+\S/;
@master_opts = $master_opts;
}
}
$master_setpgrp = delete $opts{master_setpgrp};
# when a password/passphrase is given, calling setpgrp is
# useless because the process runs attached to a different tty
undef $master_setpgrp if $login_handler or defined $passwd;
}
my $default_ssh_opts = delete $opts{default_ssh_opts};
carp "'default_ssh_opts' argument looks like if it should be splited first"
if defined $default_ssh_opts and not ref $default_ssh_opts and $default_ssh_opts =~ /^-\w\s+\S/;
my ($default_stdout_fh, $default_stderr_fh, $default_stdin_fh,
$default_stdout_file, $default_stderr_file, $default_stdin_file,
$default_stdout_discard, $default_stderr_discard, $default_stdin_discard);
$default_stdout_file = (delete $opts{default_stdout_discard}
? '/dev/null'
: delete $opts{default_stdout_file});
$default_stdout_fh = delete $opts{default_stdout_fh}
unless defined $default_stdout_file;
$default_stderr_file = (delete $opts{default_stderr_discard}
? '/dev/null'
: delete $opts{default_stderr_file});
$default_stderr_fh = delete $opts{default_stderr_fh}
unless defined $default_stderr_file;
$default_stdin_file = (delete $opts{default_stdin_discard}
? '/dev/null'
: delete $opts{default_stdin_file});
$default_stdin_fh = delete $opts{default_stdin_fh}
unless defined $default_stdin_file;
_croak_bad_options %opts;
my @ssh_opts;
# TODO: are those options really requiered or just do they eat on
# the command line limited length?
push @ssh_opts, -l => $user if defined $user;
push @ssh_opts, -p => $port if defined $port;
my $home = do {
local ($@, $SIG{__DIE__});
eval { Cwd::realpath((getpwuid $>)[7]) }
};
if (${^TAINT}) {
($home) = $home =~ /^(.*)$/;
Scalar::Util::tainted($ENV{PATH}) and
_tcroak('Insecure $ENV{PATH}');
}
my $self = { _error => 0,
_error_prefix => [],
_perl_pid => $$,
_thread_generation => $thread_generation,
_ssh_version => $ssh_version,
_ssh_cmd => $ssh_cmd,
_scp_cmd => $scp_cmd,
_rsync_cmd => $rsync_cmd,
_sshfs_cmd => $sshfs_cmd,
_sftp_server_cmd => $sftp_server_cmd,
_pid => undef,
_host => $host,
_host_squared => $host_squared,
_user => $user,
_port => $port,
_passwd => $obfuscate->($passwd),
_passwd_prompt => $passwd_prompt,
_passphrase => $passphrase,
_key_path => $key_path,
_login_handler => $login_handler,
_timeout => $timeout,
_proxy_command => $proxy_command,
_gateway_args => $gateway,
_kill_ssh_on_timeout => $kill_ssh_on_timeout,
_batch_mode => $batch_mode,
_home => $home,
_forward_agent => $forward_agent,
_forward_X11 => $forward_X11,
_external_master => $external_master,
_default_ssh_opts => $default_ssh_opts,
_default_stdin_fh => $default_stdin_fh,
_default_stdout_fh => $default_stdout_fh,
_default_stderr_fh => $default_stderr_fh,
_master_stdout_fh => $master_stdout_fh,
_master_stderr_fh => $master_stderr_fh,
_master_stdout_discard => $master_stdout_discard,
_master_stderr_discard => $master_stderr_discard,
_master_setpgrp => $master_setpgrp,
_remote_shell => $remote_shell,
_default_stream_encoding => $default_stream_encoding,
_default_argument_encoding => $default_argument_encoding,
_expand_vars => $expand_vars,
_vars => $vars,
_master_state => _STATE_START,
};
bless $self, $class;
$self->_detect_ssh_version;
# default file handles are opened so late in order to have the
# $self object to report errors
$self->{_default_stdout_fh} = $self->_open_file('>', $default_stdout_file)
if defined $default_stdout_file;
$self->{_default_stderr_fh} = $self->_open_file('>', $default_stderr_file)
if defined $default_stderr_file;
$self->{_default_stdin_fh} = $self->_open_file('<', $default_stdin_file)
if defined $default_stdin_file;
if ($self->error == OSSH_SLAVE_PIPE_FAILED) {
$self->_master_fail($async, "Unable to create default slave stream", $self->{_error});
return $self;
}
$self->{_ssh_opts} = [$self->_expand_vars(@ssh_opts)];
$self->{_master_opts} = [$self->_expand_vars(@master_opts)];
$ctl_path = $self->_expand_vars($ctl_path);
$ctl_dir = $self->_expand_vars($ctl_dir);
unless (defined $ctl_path) {
$external_master and croak "external_master is set but ctl_path is not defined";
unless (defined $ctl_dir) {
unless (defined $self->{_home}) {
$self->_master_fail($async, "unable to determine home directory for uid $>");
return $self;
}
$ctl_dir = File::Spec->catdir($self->{_home}, ".libnet-openssh-perl");
}
mkdir $ctl_dir, 0700;
unless (-d $ctl_dir) {
$self->_master_fail($async, "unable to create ctl_dir $ctl_dir");
return $self;
}
my $target = join('-', grep defined, $user, $host, $port);
for (1..10) {
$ctl_path = File::Spec->join($ctl_dir, sprintf("%s-%d-%d", substr($target, 0, 20), $$, rand(1e6)));
last unless -e $ctl_path
}
if (-e $ctl_path) {
$self->_master_fail($async, "unable to find unused name for ctl_path inside ctl_dir $ctl_dir");
return $self;
}
}
$ctl_dir = File::Spec->catpath((File::Spec->splitpath($ctl_path))[0,1], "");
$debug and $debug & 2 and _debug "ctl_path: $ctl_path, ctl_dir: $ctl_dir";
if ($strict_mode and !$self->_is_secure_path($ctl_dir)) {
$self->_master_fail($async, "ctl_dir $ctl_dir is not secure");
return $self;
}
$self->{_ctl_path} = $ctl_path;
$self->_master_wait($async) if $connect;
$self;
}
sub get_user { shift->{_user} }
sub get_host { shift->{_host} }
sub get_port { shift->{_port} }
sub get_master_pid { shift->{_pid} }
sub get_ctl_path { shift->{_ctl_path} }
sub get_expand_vars { shift->{_expand_vars} }
sub set_expand_vars {
my $self = shift;
$self->{_expand_vars} = (shift(@_) ? 1 : 0);
}
sub set_var {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my $k = shift;
$k =~ /^(?:USER|HOST|PORT)$/
and croak "internal variable %$k% can not be set";
$self->{_vars}{$k} = shift;
}
sub get_var {
my ($self, $k) = @_;
my $v = ( $k =~ /^(?:USER|HOST|PORT)$/
? $self->{lc "_$k"}
: $self->{_vars}{$k} );
(defined $v ? $v : '');
}
sub _expand_vars {
my ($self, @str) = @_;
if (ref $self and $self->{_expand_vars}) {
for (@str) {
s{%(\w*)%}{length ($1) ? $self->get_var($1) : '%'}ge
if defined $_;
}
}
wantarray ? @str : $str[0]
}
sub error { shift->{_error} }
sub die_on_error {
my $ssh = shift;
$ssh->{_error} and croak(@_ ? "@_: $ssh->{_error}" : $ssh->{_error});
}
sub _is_secure_path {
my ($self, $path) = @_;
my @parts = File::Spec->splitdir(Cwd::realpath($path));
my $home = $self->{_home};
for my $last (reverse 0..$#parts) {
my $dir = File::Spec->catdir(@parts[0..$last]);
unless (-d $dir) {
$debug and $debug & 2 and _debug "$dir is not a directory";
return undef;
}
my ($mode, $uid) = (stat $dir)[2, 4];
$debug and $debug & 2 and _debug "_is_secure_path(dir: $dir, file mode: $mode, file uid: $uid, euid: $>";
return undef unless(($uid == $> or $uid == 0 ) and (($mode & 022) == 0 or ($mode & 01000)));
return 1 if (defined $home and $home eq $dir);
}
return 1;
}
sub _detect_ssh_version {
my $self = shift;
if (defined $self->{_ssh_version}) {
$debug and $debug & 4 and _debug "ssh version given as $self->{_ssh_version}";
}
else {
my (undef, $out, undef, $pid) = $self->open_ex({_cmd => 'raw',
_no_master_required => 1,
stdout_pipe => 1,
stdin_discard => 1,
stderr_to_stdout => 1 },
$self->{_ssh_cmd}, '-V');
my ($txt) = $self->_io3($out, undef, undef, undef, 10, 'bytes');
local $self->{_kill_ssh_on_timeout} = 1;
$self->_waitpid($pid, 10);
if (my ($full, $num) = $txt =~ /^OpenSSH_((\d+\.\d+)\S*)/mi) {
$debug and $debug & 4 and _debug "OpenSSH version is $full";
$self->{_ssh_version} = $num;
}
else {
$self->{_ssh_version} = 0;
$debug and $debug & 4 and _debug "unable to determine version, '$self->{_ssh_cmd} -V', output:\n$txt"
}
}
}
sub _make_ssh_call {
my $self = shift;
my @before = @{shift || []};
my @args = ($self->{_ssh_cmd}, @before,
-S => $self->{_ctl_path},
@{$self->{_ssh_opts}}, $self->{_host},
'--',
(@_ ? "@_" : ()));
$debug and $debug & 8 and _debug_dump 'call args' => \@args;
@args;
}
sub _scp_cmd {
my $self = shift;
$self->{_scp_cmd} ||= do {
my $scp = $self->{_ssh_cmd};
$scp =~ s/ssh$/scp/i or croak "scp command name not set";
$scp;
}
}
sub _make_scp_call {
my $self = shift;
my @before = @{shift || []};
my @args = ($self->_scp_cmd, @before,
-o => "ControlPath=$self->{_ctl_path}",
-S => $self->{_ssh_cmd},
(defined $self->{_port} ? (-P => $self->{_port}) : ()),
'--', @_);
$debug and $debug & 8 and _debug_dump 'scp call args' => \@args;
@args;
}
sub _rsync_quote {
my ($self, @args) = @_;
for (@args) {
if (/['"\s]/) {
s/"/""/g;
$_ = qq|"$_"|;
}
s/%/%%/;
}
wantarray ? @args : join(' ', @args);
}
sub _make_rsync_call {
my $self = shift;
my $before = shift;
my @transport = ($self->{_ssh_cmd}, @$before,
-S => $self->{_ctl_path});
my $transport = $self->_rsync_quote(@transport);
my @args = ( $self->{_rsync_cmd},
-e => $transport,
@_);
$debug and $debug & 8 and _debug_dump 'rsync call args' => \@args;
@args;
}
sub _make_W_option {
my $self = shift;
if (@_ == 1) {
my $path = shift;
$path = "./$path" unless $path =~ m|/|;
$path =~ s/([\\:])/\\$1/g;
return "-W$path";
}
if (@_ == 2) {
return "-W" . join(':', @_);
}
croak "bad number of arguments for creating a tunnel"
}
sub _make_tunnel_call {
my $self = shift;
my @before = @{shift||[]};
push @before, $self->_make_W_option(@_);
my @args = $self->_make_ssh_call(\@before);
$debug and $debug & 8 and _debug_dump 'tunnel call args' => \@args;
@args;
}
sub master_exited {
my $self = shift;
$self->_master_gone(1)
}
sub _master_gone {
my $self = shift;
my $async = shift;
delete $self->{_pid};
$self->_master_fail($async, (@_ ? @_ : "master process exited unexpectedly"));
}
my @kill_signal = qw(0 0 TERM TERM TERM KILL);
sub __has_sigchld_handle {
my $h = $SIG{CHLD};
defined $h and $h ne 'IGNORE' and $h ne 'DEFAULT'
}
sub _master_kill {
my ($self, $async) = @_;
if (my $pid = $self->_my_master_pid) {
$debug and $debug & 32 and _debug '_master_kill: ', $pid;
my $now = time;
my $start = $self->{_master_kill_start} ||= $now;
$self->{_master_kill_last} ||= $now;
$self->{_master_kill_count} ||= 0;
local $SIG{CHLD} = sub {} unless $async or __has_sigchld_handle;
while (1) {
if ($self->{_master_kill_last} < $now) {
$self->{_master_kill_last} = $now;
my $sig = $kill_signal[$self->{_master_kill_count}++];
$sig = 'KILL' unless defined $sig;
$debug and $debug & 32 and _debug "killing master $$ with signal $sig";
kill $sig, $pid;
}
my $deceased = waitpid($pid, WNOHANG);
$debug and $debug & 32 and _debug "waitpid(master: $pid) => pid: $deceased, rc: $!";
last if $deceased == $pid or ($deceased < 0 and $! == Errno::ECHILD());
if ($self->{_master_kill_count} > 20) {
# FIXME: remove the hard-coded 20 retries?
$debug and $debug & 32 and _debug "unable to kill SSH master process, giving up";
last;
}
return if $async;
select(undef, undef, undef, 0.2);
$now = time;
}
}
else {
$debug and $debug & 32 and _debug("not killing master SSH (", $self->{_pid}, ") started from " .
"process ", $self->{_perl_pid}, "/", $self->{_thread_generation},
", current ", $$, "/", $thread_generation, ")");
}
$self->_master_gone($async);
}
sub disconnect {
my ($self, $async) = @_;
@_ <= 2 or croak 'Usage: $self->disconnect([$async])';
$self->_disconnect($async, 1);
}
sub disown_master {
my $self = shift;
if (my $pid = $self->_my_master_pid) {
if ($self->wait_for_master) {
$self->{_external_master} = 1;
return $pid;
}
}
undef;
}
sub _my_master_pid {
my $self = shift;
unless ($self->{_external_master}) {
my $pid = $self->{_pid};
return $pid if
$pid and $self->{_perl_pid} == $$ and $self->{_thread_generation} == $thread_generation;
}
()
}
sub _disconnect {
my ($self, $async, $send_ctl) = @_;
return if $self->{_master_state} == _STATE_GONE;
if (!$async and
$self->{_master_state} == _STATE_RUNNING and
($send_ctl or $self->_my_master_pid)) {
# we have successfully created the master connection so we
# can send control commands:
$debug and $debug & 32 and _debug("sending exit control to master");
$self->_master_ctl('exit');
}
$self->_master_fail($async, 'aborted')
}
sub _check_is_system_fh {
my ($name, $fh) = @_;
my $fn = fileno(defined $fh ? $fh : $name);
defined $fn and $fn >= 0 and return;
croak "child process $name is not a real system file handle";
}
sub _master_redirect {
my $self = shift;
my $uname = uc shift;
my $name = lc $uname;
no strict 'refs';
if ($self->{"_master_${name}_discard"}) {
open *$uname, '>>', '/dev/null';
}
else {
my $fh = $self->{"_master_${name}_fh"};
$fh = $self->{"_default_${name}_fh"} unless defined $fh;
if (defined $fh) {
_check_is_system_fh $uname => $fh;
if (fileno $fh != fileno *$uname) {
open *$uname, '>>&', $fh or POSIX::_exit(255);
}
}
}
}
sub _waitpid {
my ($self, $pid, $timeout) = @_;
$? = 0;
if ($pid) {
$timeout = $self->{_timeout} unless defined $timeout;
my $time_limit;
if (defined $timeout and $self->{_kill_ssh_on_timeout}) {
$timeout = 0 if $self->error == OSSH_SLAVE_TIMEOUT;
$time_limit = time + $timeout;
}
local $SIG{CHLD} = sub {} unless __has_sigchld_handle;
while (1) {
my $deceased;
if (defined $time_limit) {
while (1) {
# TODO: we assume that all OSs return 0 when the
# process is still running, that may be wrong!
$deceased = waitpid($pid, WNOHANG) and last;
my $remaining = $time_limit - time;
if ($remaining <= 0) {
$debug and $debug & 16 and _debug "killing SSH slave, pid: $pid";
kill TERM => $pid;
$self->_or_set_error(OSSH_SLAVE_TIMEOUT, "ssh slave failed", "timed out");
}
# There is a race condition here. We try to
# minimize it keeping the waitpid and the select
# together and limiting the sleep time to 1s:
my $sleep = ($remaining < 0.1 ? 0.1 : 1);
$debug and $debug & 16 and
_debug "waiting for slave, timeout: $timeout, remaining: $remaining, sleep: $sleep";
$deceased = waitpid($pid, WNOHANG) and last;
select(undef, undef, undef, $sleep);
}
}
else {
$deceased = waitpid($pid, 0);
}
$debug and $debug & 16 and _debug "_waitpid($pid) => pid: $deceased, rc: $?, err: $!";
if ($deceased == $pid) {
if ($?) {
my $signal = ($? & 255);
my $errstr = "child exited with code " . ($? >> 8);
$errstr .= ", signal $signal" if $signal;
$self->_or_set_error(OSSH_SLAVE_CMD_FAILED, $errstr);
return undef;
}
return 1;
}
elsif ($deceased < 0) {
# at this point $deceased < 0 and so, $! has a valid error value.
next if $! == Errno::EINTR();
if ($! == Errno::ECHILD()) {
$self->_or_set_error(OSSH_SLAVE_FAILED, "child process $pid does not exist", $!);
return undef
}
warn "Internal error: unexpected error (".($!+0).": $!) from waitpid($pid) = $deceased. Report it, please!";
}
elsif ($deceased > 0) {
warn "Internal error: spurious process $deceased exited"
}
# wait a bit before trying again
select(undef, undef, undef, 0.1);
}
}
else {
$self->_or_set_error(OSSH_SLAVE_FAILED, "spawning of new process failed");
return undef;
}
}
sub check_master {
my $self = shift;
@_ and croak 'Usage: $ssh->check_master()';
$self->_master_check(0);
}
sub wait_for_master {
my ($self, $async) = @_;
@_ <= 2 or croak 'Usage: $ssh->wait_for_master([$async])';
$self->{_error} = 0
unless $self->{_error} == OSSH_MASTER_FAILED;
$self->_master_wait($async);
}
sub _master_start {
my ($self, $async) = @_;
$self->_set_error;
my $timeout = int((($self->{_timeout} || 90) + 2)/3);
my $ssh_flags= '-2MN';
$ssh_flags .= ($self->{_forward_agent} ? 'A' : 'a') if defined $self->{_forward_agent};
$ssh_flags .= ($self->{_forward_X11} ? 'X' : 'x');
my @master_opts = (@{$self->{_master_opts}},
-o => "ServerAliveInterval=$timeout",
($self->{_ssh_version} >= 5.6 ? (-o => "ControlPersist=no") : ()),
$ssh_flags);
my ($mpty, $use_pty, $pref_auths);
$use_pty = 1 if defined $self->{_login_handler};
if (defined $self->{_passwd}) {
$use_pty = 1;
$pref_auths = ($self->{_passphrase}
? 'publickey'
: 'keyboard-interactive,password');
push @master_opts, -o => 'NumberOfPasswordPrompts=1';
}
elsif ($self->{_batch_mode}) {
push @master_opts, -o => 'BatchMode=yes';
}
if (defined $self->{_key_path}) {
$pref_auths = 'publickey';
push @master_opts, -i => $self->{_key_path};
}
my $proxy_command = $self->{_proxy_command};
my $gateway;
if (my $gateway_args = $self->{_gateway_args}) {
if (ref $gateway_args eq 'HASH') {
_load_module('Net::OpenSSH::Gateway');
my $errors;
unless ($gateway = Net::OpenSSH::Gateway->find_gateway(errors => $errors,
host => $self->{_host}, port => $self->{_port},
%$gateway_args)) {
return $self->_master_fail($async, 'Unable to build gateway object', join(', ', @$errors));
}
}
else {
$gateway = $gateway_args
}
$self->{_gateway} = $gateway;
$gateway->before_ssh_connect or
return $self->_master_fail($async, 'Gateway setup failed', join(', ', $gateway->errors));
$proxy_command = $gateway->proxy_command;
}
if (defined $proxy_command) {
push @master_opts, -o => "ProxyCommand=$proxy_command";
}
if ($use_pty) {
_load_module('IO::Pty');
$self->{_mpty} = $mpty = IO::Pty->new;
}
push @master_opts, -o => "PreferredAuthentications=$pref_auths"
if defined $pref_auths;
my @call = $self->_make_ssh_call(\@master_opts);
my $pid = fork;
unless ($pid) {
defined $pid
or return $self->_master_fail($async, "unable to fork ssh master: $!");
if ($debug and $debug & 512) {
require Net::OpenSSH::OSTracer;
Net::OpenSSH::OSTracer->trace;
}
$mpty->make_slave_controlling_terminal if $mpty;
$self->_master_redirect('STDOUT');
$self->_master_redirect('STDERR');
delete $ENV{SSH_ASKPASS} if defined $self->{_passwd};
delete $ENV{SSH_AUTH_SOCK} if defined $self->{_passphrase};
setpgrp if $self->{_master_setpgrp};
local $SIG{__DIE__};
eval { exec @call };
POSIX::_exit(255);
}
$self->{_pid} = $pid;
1;
}
sub _master_check {
my ($self, $async) = @_;
my $error;
if ($async) {
return 1 if -S $self->{_ctl_path};
$error = "master SSH connection broken";
}
else {
my $out = $self->_master_ctl('check');
my $error = $self->{_error};
unless ($error) {
my $pid = $self->{_pid};
if ($out =~ /pid=(\d+)/) {
return 1 if !$pid or $1 == $pid;
$error = "bad ssh master at $self->{_ctl_path} socket owned by pid $1 (pid $pid expected)";
}
else {
$error = ($out =~ /illegal option/i
? 'OpenSSH 4.1 or later required'
: 'unknown error');
}
}
}
$self->_master_fail($async, $error);
}
sub _master_fail {
my $self = shift;
my $async = shift;
if ($self->{_error} != OSSH_MASTER_FAILED) {
$self->_set_error(OSSH_MASTER_FAILED, @_);
}
$self->_master_jump_state($self->{_pid} ? _STATE_KILLING : _STATE_GONE, $async);
}
sub _master_jump_state {
my ($self, $state, $async) = @_;
$debug and $debug & 4 and _debug "master state jumping from $self->{_master_state} to $state";
if ($state == $self->{_master_state} and
$state != _STATE_KILLING and
$state != _STATE_GONE) {
croak "internal error: state jump to itself ($state)!";
}
$self->{_master_state} = $state;
return $self->_master_wait($async);
}
sub _master_wait {
my ($self, $async) = @_;
my $pid = $self->_my_master_pid;
if ($pid) {
my $deceased = waitpid($pid, WNOHANG);
if ($deceased == $pid or ($deceased < 0 and $! == Errno::ECHILD())) {
$debug and $debug & 4 and _debug "master $pid exited, rc:", $?,", err: ",$!;
return $self->_master_gone($async);
}
}
if ($self->{_master_state} == _STATE_RUNNING) {
return 1 if -S $self->{_ctl_path};
return $self->_master_fail($async, "master SSH connection broken");
}
if ($self->{_master_state} == _STATE_KILLING) {
$debug and $debug & 4 and _debug "killing master";
return $self->_master_kill($async);
}
if ($self->{_master_state} == _STATE_START) {
if ($self->{_external_master}) {
return ($self->_master_jump_state(_STATE_RUNNING, $async) and
$self->_master_check($async))
}
$self->_master_start($async) or return;
if (defined $self->{_passwd} or $self->{_login_handler}) {
$self->{_wfm_bout} = '';
return $self->_master_jump_state(_STATE_LOGIN, $async);
}
return $self->_master_jump_state(_STATE_AWAITING_MUX, $async);
}
if ($self->{_master_state} == _STATE_GONE or
$self->{_master_state} == _STATE_STOPPED) {
return 0;
}
# At this point we are either in state AWAITIN_MUX or LOGIN
local $self->{_error_prefix} = [@{$self->{_error_prefix}},
"unable to establish master SSH connection"];
$pid or return $self->_master_gone($async,
"perl process was forked or threaded before SSH connection had been established");
my $old_tcpgrp;
if ($self->{_master_setpgrp} and not $async and
not $self->{_batch_mode} and not $self->{_external_master}) {
$old_tcpgrp = POSIX::tcgetpgrp(0);
if ($old_tcpgrp > 0) {
# let the master process ask for passwords at the TTY
POSIX::tcsetpgrp(0, $pid);
}
else {
undef $old_tcpgrp;
}
}
my $mpty = $self->{_mpty};
my $fnopty;
my $rv = '';
if ($self->{_master_state} == _STATE_LOGIN) {
$fnopty = fileno $mpty;
vec($rv, $fnopty, 1) = 1
}
my $timeout = $self->{_timeout};
my $dt = ($async ? 0 : 0.02);
my $start_time = time;
my $error;
# Loop until the mux socket appears or something goes wrong:
while (1) {
$dt *= 1.10 if $dt < 0.2; # adaptative delay
if (-e $self->{_ctl_path}) {
$debug and $debug & 4 and _debug "file object found at $self->{_ctl_path}";
last;
}
$debug and $debug & 4 and _debug "file object not yet found at $self->{_ctl_path}, state:", $self->{_master_state};
if (defined $timeout and (time - $start_time) > $timeout) {
$error = "login timeout";
last;
}
my $deceased = waitpid($pid, WNOHANG);
if ($deceased == $pid or ($deceased < 0 and $! == Errno::ECHILD())) {
$error = "master process exited unexpectedly";
$error = "bad pass" . ($self->{_passphrase} ? 'phrase' : 'word') . " or $error"
if defined $self->{_passwd};
delete $self->{_pid};
last;
}
if ($self->{_login_handler} and $self->{_master_state} == _STATE_LOGIN) {
local ($@, $SIG{__DIE__});
if (eval { $self->{_login_handler}->($self, $mpty, \$self->{_wfm_bout}) }) {
$self->{_master_state} = _STATE_AWAITING_MUX;
next;
}
if ($@) {
$error = "custom login handler failed: $@";
last;
}
# fallback
}
else {
# we keep reading from mpty even after leaving state
# STATE_LOGIN in order to search for additional password
# prompts.
my $rv1 = $rv;
my $n = select($rv1, undef, undef, $dt);
if ($n > 0) {
vec($rv1, $fnopty, 1) or die "internal error";
my $read = sysread($mpty, $self->{_wfm_bout}, 4096, length $self->{_wfm_bout});
if ($read) {
my $passwd_prompt = _first_defined $self->{_passwd_prompt}, qr/[:?]/;
$passwd_prompt = quotemeta $passwd_prompt unless ref $passwd_prompt;
if ($self->{_master_state} == _STATE_LOGIN) {
if ($self->{_wfm_bout} =~ /The authenticity of host.*can't be established/si) {
$error = "the authenticity of the target host can't be established; the remote host " .
"public key is probably not present on the '~/.ssh/known_hosts' file";
last;
}
if ($self->{_wfm_bout} =~ /WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED/si) {
$error = "the authenticity of the target host can't be established; the remote host " .
"public key doesn't match the one stored locally";
last;
}
if ($self->{_wfm_bout} =~ /^(.*$passwd_prompt)/s) {
$debug and $debug & 4 and _debug "passwd/passphrase requested ($1)";
print $mpty $deobfuscate->($self->{_passwd}) . "\n";
$self->{_wfm_bout} = ''; # reset
$self->{_master_state} = _STATE_AWAITING_MUX;
}
}
elsif (length($passwd_prompt) and $self->{_wfm_bout} =~ /^(.*$passwd_prompt)\s*$/s) {
$debug and $debug & 4 and _debug "passwd/passphrase requested again ($1)";
$error = "password authentication failed";
last;
}
next; # skip delay
}
}
}
return if $async;
select(undef, undef, undef, $dt);
}
if (defined $old_tcpgrp) {
$debug and $debug & 4 and
_debug("ssh pid: $pid, pgrp: ", getpgrp($pid),
", \$\$: ", $$,
", tcpgrp: ", POSIX::tcgetpgrp(0),
", old_tcppgrp: ", $old_tcpgrp);
local $SIG{TTOU} = 'IGNORE';
POSIX::tcsetpgrp(0, $old_tcpgrp);
}
if ($error) {
return $self->_master_fail($async, $error);
}
$self->_master_jump_state(_STATE_RUNNING, $async)
and $self->_master_check($async);
}
sub _master_ctl {
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
my $cmd = shift;
local $self->{_error_prefix} = [@{$self->{_error_prefix}},
"control command failed"];
$self->capture({ %opts,
encoding => 'bytes', # don't let the encoding
# stuff get in the way
stdin_discard => 1, tty => 0,
stderr_to_stdout => 1, ssh_opts => [-O => $cmd]});
}
sub stop {
my ($self, $timeout) = @_;
my $pid = $self->{_pid};
local $self->{_kill_ssh_on_timeout} = 1;
$self->_master_ctl({timeout => $timeout}, 'stop');
unless ($self->{_error}) {
$self->_set_error(OSSH_MASTER_FAILED, "master stopped");
$self->_master_jump_state(_STATE_STOPPED, 1);
}
}
sub _make_pipe {
my $self = shift;
my ($r, $w);
if (pipe $r, $w) {
my $old = select;
select $r; $ |= 1;
select $w; $ |= 1;
select $old;
return ($r, $w);
}
$self->_set_error(OSSH_SLAVE_PIPE_FAILED, "unable to create pipe: $!");
return;
}
sub _remote_quoter {
my ($self, $remote_shell) = @_;
if (ref $self and (!defined $remote_shell or $remote_shell eq $self->{_remote_shell})) {
return $self->{remote_quoter} ||= Net::OpenSSH::ShellQuoter->quoter($self->{_remote_shell});
}
Net::OpenSSH::ShellQuoter->quoter($remote_shell);
}
sub _quote_args {
my $self = shift;
my $opts = shift;
ref $opts eq 'HASH' or die "internal error";
my $quote = delete $opts->{quote_args};
my $quote_extended = delete $opts->{quote_args_extended};
my $glob_quoting = delete $opts->{glob_quoting};
$quote = (@_ > 1) unless defined $quote;
if ($quote) {
my $remote_shell = delete $opts->{remote_shell};
my $quoter = $self->_remote_quoter($remote_shell);
my $quote_method = ($glob_quoting ? 'quote_glob' : 'quote');
# foo => $quoter
# \foo => $quoter_glob
# \\foo => no quoting at all and disable extended quoting as it is not safe
my @quoted;
for (@_) {
if (ref $_) {
if (ref $_ eq 'SCALAR') {
push @quoted, $quoter->quote_glob($self->_expand_vars($$_));
}
elsif (ref $_ eq 'REF' and ref $$_ eq 'SCALAR') {
push @quoted, $self->_expand_vars($$$_);
undef $quote_extended;
}
else {
croak "invalid reference in remote command argument list"
}
}
else {
push @quoted, $quoter->$quote_method($self->_expand_vars($_));
}
}
if ($quote_extended) {
my @fragments;
if ( $opts->{stdout_discard} and
( $opts->{stderr_discard} or $opts->{stderr_to_stdout} ) ) {
@fragments = ('stdout_and_stderr_discard');
push @fragments, 'stdin_discard' if $opts->{stdin_discard};
}
else {
@fragments = grep $opts->{$_}, qw(stdin_discard stdout_discard
stderr_discard stderr_to_stdout);
}
push @quoted, $quoter->shell_fragments(@fragments);
}
wantarray ? @quoted : join(" ", @quoted);
}
else {
croak "reference found in argument list when argument quoting is disabled"
if (grep ref, @_);
my @args = $self->_expand_vars(@_);
wantarray ? @args : join(" ", @args);
}
}
sub shell_quote {
shift->_quote_args({quote_args => 1}, @_);
}
sub shell_quote_glob {
shift->_quote_args({quote_args => 1, glob_quoting => 1}, @_);
}
sub _array_or_scalar_to_list { map { defined($_) ? (ref $_ eq 'ARRAY' ? @$_ : $_ ) : () } @_ }
sub make_remote_command {
my $self = shift;
$self->wait_for_master or return;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
my @ssh_opts = _array_or_scalar_to_list delete $opts{ssh_opts};
my $tty = delete $opts{tty};
my $ssh_flags = '';
$ssh_flags .= ($tty ? 'qtt' : 'T') if defined $tty;
if ($self->{_forward_agent}) {
my $forward_agent = delete $opts{forward_agent};
$ssh_flags .= ($forward_agent ? 'A' : 'a') if defined $forward_agent;
}
if ($self->{_forward_X11}) {
my $forward_X11 = delete $opts{forward_X11};
$ssh_flags .= ($forward_X11 ? 'X' : 'x');
}
my $tunnel = delete $opts{tunnel};
my (@args);
if ($tunnel) {
push @ssh_opts, $self->_make_W_option(@_);
}
else {
@args = $self->_quote_args(\%opts, @_);
}
_croak_bad_options %opts;
push @ssh_opts, "-$ssh_flags" if length $ssh_flags;
my @call = $self->_make_ssh_call(\@ssh_opts, @args);
if (wantarray) {
$debug and $debug & 16 and _debug_dump make_remote_command => \@call;
return @call;
}
else {
my $call = join ' ', $self->shell_quote(@call);
$debug and $debug & 16 and _debug_dump 'make_remote_command (quoted)' => $call;
return $call
}
}
sub _open_file {
my ($self, $default_mode, $name_or_args) = @_;
my ($mode, @args) = (ref $name_or_args
? @$name_or_args
: ($default_mode, $name_or_args));
@args = $self->_expand_vars(@args);
if (open my $fh, $mode, @args) {
return $fh;
}
else {
$self->_set_error(OSSH_SLAVE_PIPE_FAILED,
"Unable to open file '$args[0]': $!");
return undef;
}
}
sub _fileno_dup_over {
my ($good_fn, $fh) = @_;
if (defined $fh) {
my $fn = fileno $fh;
for (1..5) {
$fn >= $good_fn and return $fn;
$fn = POSIX::dup($fn);
}
POSIX::_exit(255);
}
undef;
}
sub _exec_dpipe {
my ($self, $cmd, $io, $err) = @_;
my $io_fd = _fileno_dup_over(3 => $io);
my $err_fd = _fileno_dup_over(3 => $err);
POSIX::dup2($io_fd, 0);
POSIX::dup2($io_fd, 1);
POSIX::dup2($err_fd, 2) if defined $err_fd;
if (ref $cmd) {
exec @$cmd;
}
else {
exec $cmd;
}
}
sub _delete_stream_encoding {
my ($self, $opts) = @_;
_first_defined(delete $opts->{stream_encoding},
$opts->{encoding},
$self->{_default_stream_encoding});
}
sub _delete_argument_encoding {
my ($self, $opts) = @_;
_first_defined(delete $opts->{argument_encoding},
delete $opts->{encoding},
$self->{_default_argument_encoding});
}
sub open_ex {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
unless (delete $opts{_no_master_required}) {
$self->wait_for_master or return;
}
my $ssh_flags = '';
my $tunnel = delete $opts{tunnel};
my ($cmd, $close_slave_pty, @args);
if ($tunnel) {
@args = @_;
}
else {
my $argument_encoding = $self->_delete_argument_encoding(\%opts);
my $tty = delete $opts{tty};
$ssh_flags .= ($tty ? 'qtt' : 'T') if defined $tty;
$cmd = delete $opts{_cmd} || 'ssh';
$opts{quote_args_extended} = 1
if (not defined $opts{quote_args_extended} and $cmd eq 'ssh');
@args = $self->_quote_args(\%opts, @_);
$self->_encode_args($argument_encoding, @args) or return;
}
my ($stdinout_socket, $stdinout_dpipe_make_parent);
my $stdinout_dpipe = delete $opts{stdinout_dpipe};
if ($stdinout_dpipe) {
$stdinout_dpipe_make_parent = delete $opts{stdinout_dpipe_make_parent};
$stdinout_socket = 1;
}
else {
$stdinout_socket = delete $opts{stdinout_socket};
}
my ($stdin_discard, $stdin_pipe, $stdin_fh, $stdin_file, $stdin_pty,
$stdout_discard, $stdout_pipe, $stdout_fh, $stdout_file, $stdout_pty,
$stderr_discard, $stderr_pipe, $stderr_fh, $stderr_file, $stderr_to_stdout);
unless ($stdinout_socket) {
unless ($stdin_discard = delete $opts{stdin_discard} or
$stdin_pipe = delete $opts{stdin_pipe} or
$stdin_fh = delete $opts{stdin_fh} or
$stdin_file = delete $opts{stdin_file}) {
unless ($tunnel) {
if ($stdin_pty = delete $opts{stdin_pty}) {
$close_slave_pty = _first_defined delete $opts{close_slave_pty}, 1;
}
}
}
( $stdout_discard = delete $opts{stdout_discard} or
$stdout_pipe = delete $opts{stdout_pipe} or
$stdout_fh = delete $opts{stdout_fh} or
$stdout_file = delete $opts{stdout_file} or
(not $tunnel and $stdout_pty = delete $opts{stdout_pty}) );
$stdout_pty and !$stdin_pty
and croak "option stdout_pty requires stdin_pty set";
}
( $stderr_discard = delete $opts{stderr_discard} or
$stderr_pipe = delete $opts{stderr_pipe} or
$stderr_fh = delete $opts{stderr_fh} or
$stderr_to_stdout = delete $opts{stderr_to_stdout} or
$stderr_file = delete $opts{stderr_file} );
my $ssh_opts = delete $opts{ssh_opts};
$ssh_opts = $self->{_default_ssh_opts} unless defined $ssh_opts;
my @ssh_opts = $self->_expand_vars(_array_or_scalar_to_list $ssh_opts);
if ($self->{_forward_agent}) {
my $forward_agent = delete $opts{forward_agent};
$ssh_flags .= ($forward_agent ? 'A' : 'a') if defined $forward_agent;
}
if ($self->{_forward_X11}) {
my $forward_X11 = delete $opts{forward_X11};
$ssh_flags .= ($forward_X11 ? 'X' : 'x');
}
my $setpgrp = delete $opts{setpgrp};
undef $setpgrp if defined $stdin_pty;
_croak_bad_options %opts;
if (defined $stdin_file) {
$stdin_fh = $self->_open_file('<', $stdin_file) or return
}
if (defined $stdout_file) {
$stdout_fh = $self->_open_file('>', $stdout_file) or return
}
if (defined $stderr_file) {
$stderr_fh = $self->_open_file('>', $stderr_file) or return
}
my ($rin, $win, $rout, $wout, $rerr, $werr);
if ($stdinout_socket) {
unless(socketpair $rin, $win, AF_UNIX, SOCK_STREAM, PF_UNSPEC) {
$self->_set_error(OSSH_SLAVE_PIPE_FAILED, "socketpair failed: $!");
return;
}
$wout = $rin;
}
else {
if ($stdin_pipe) {
($rin, $win) = $self->_make_pipe or return;
}
elsif ($stdin_pty) {
_load_module('IO::Pty');
$win = IO::Pty->new;
unless ($win) {
$self->_set_error(OSSH_SLAVE_PIPE_FAILED, "unable to allocate pseudo-tty: $!");
return;
}
$rin = $win->slave;
}
elsif (defined $stdin_fh) {
$rin = $stdin_fh;
}
else {
$rin = $self->{_default_stdin_fh}
}
_check_is_system_fh STDIN => $rin;
if ($stdout_pipe) {
($rout, $wout) = $self->_make_pipe or return;
}
elsif ($stdout_pty) {
$wout = $rin;
}
elsif (defined $stdout_fh) {
$wout = $stdout_fh;
}
else {
$wout = $self->{_default_stdout_fh};
}
_check_is_system_fh STDOUT => $wout;
}
unless ($stderr_to_stdout) {
if ($stderr_pipe) {
($rerr, $werr) = $self->_make_pipe or return;
}
elsif (defined $stderr_fh) {
$werr = $stderr_fh;
}
else {
$werr = $self->{_default_stderr_fh};
}
_check_is_system_fh STDERR => $werr;
}
push @ssh_opts, "-$ssh_flags" if length $ssh_flags;
my @call = ( $tunnel ? $self->_make_tunnel_call(\@ssh_opts, @args) :
$cmd eq 'ssh' ? $self->_make_ssh_call(\@ssh_opts, @args) :
$cmd eq 'scp' ? $self->_make_scp_call(\@ssh_opts, @args) :
$cmd eq 'rsync' ? $self->_make_rsync_call(\@ssh_opts, @args) :
$cmd eq 'raw' ? @args :
die "Internal error: bad _cmd protocol" );
$debug and $debug & 16 and _debug_dump open_ex => \@call;
my $pid = fork;
unless ($pid) {
unless (defined $pid) {
$self->_set_error(OSSH_SLAVE_FAILED,
"unable to fork new ssh slave: $!");
return;
}
setpgrp if $setpgrp;
$stdin_discard and (open $rin, '<', '/dev/null' or POSIX::_exit(255));
$stdout_discard and (open $wout, '>', '/dev/null' or POSIX::_exit(255));
$stderr_discard and (open $werr, '>', '/dev/null' or POSIX::_exit(255));
if ($stdinout_dpipe) {
my $pid1 = fork;
defined $pid1 or POSIX::_exit(255);
unless ($pid1 xor $stdinout_dpipe_make_parent) {
eval { $self->_exec_dpipe($stdinout_dpipe, $win, $werr) };
POSIX::_exit(255);
}
}
my $rin_fd = _fileno_dup_over(0 => $rin);
my $wout_fd = _fileno_dup_over(1 => $wout);
my $werr_fd = _fileno_dup_over(2 => $werr);
if (defined $rin_fd) {
$win->make_slave_controlling_terminal if $stdin_pty;
$rin_fd == 0 or POSIX::dup2($rin_fd, 0) or POSIX::_exit(255);
}
if (defined $wout_fd) {
$wout_fd == 1 or POSIX::dup2($wout_fd, 1) or POSIX::_exit(255);
}
if (defined $werr_fd) {
$werr_fd == 2 or POSIX::dup2($werr_fd, 2) or POSIX::_exit(255);
}
elsif ($stderr_to_stdout) {
POSIX::dup2(1, 2) or POSIX::_exit(255);
}
do { exec @call };
POSIX::_exit(255);
}
$win->close_slave() if $close_slave_pty;
undef $win if defined $stdinout_dpipe;
wantarray ? ($win, $rout, $rerr, $pid) : $pid;
}
sub pipe_in {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
$self->wait_for_master or return;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
my $argument_encoding = $self->_delete_argument_encoding(\%opts);
my @args = $self->_quote_args(\%opts, @_);
_croak_bad_options %opts;
$self->_encode_args($argument_encoding, @args) or return;
my @call = $self->_make_ssh_call([], @args);
$debug and $debug & 16 and _debug_dump pipe_in => @call;
my $pid = open my $rin, '|-', @call;
unless ($pid) {
$self->_set_error(OSSH_SLAVE_FAILED,
"unable to fork new ssh slave: $!");
return;
}
wantarray ? ($rin, $pid) : $rin;
}
sub pipe_out {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
$self->wait_for_master or return;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
my $argument_encoding = $self->_delete_argument_encoding(\%opts);
my @args = $self->_quote_args(\%opts, @_);
_croak_bad_options %opts;
$self->_encode_args($argument_encoding, @args) or return;
my @call = $self->_make_ssh_call([], @args);
$debug and $debug & 16 and _debug_dump pipe_out => @call;
my $pid = open my $rout, '-|', @call;
unless ($pid) {
$self->_set_error(OSSH_SLAVE_FAILED,
"unable to fork new ssh slave: $!");
return;
}
wantarray ? ($rout, $pid) : $rout;
}
sub _find_encoding {
my ($self, $encoding, $data) = @_;
if (defined $encoding and $encoding ne 'bytes') {
_load_module('Encode');
my $enc = Encode::find_encoding($encoding);
unless (defined $enc) {
$self->_set_error(OSSH_ENCODING_ERROR, "bad encoding '$encoding'");
return
}
return $enc
}
return undef
}
sub _encode {
my $self = shift;
my $enc = shift;
if (defined $enc and @_) {
local ($@, $SIG{__DIE__});
eval {
for (@_) {
defined or next;
$_ = $enc->encode($_, Encode::FB_CROAK());
}
};
$self->_check_eval_ok(OSSH_ENCODING_ERROR) or return undef;
}
1;
}
sub _encode_args {
if (@_ > 2) {
my $self = shift;
my $encoding = shift;
my $enc = $self->_find_encoding($encoding);
if ($enc) {
local $self->{_error_prefix} = [@{$self->{_error_prefix}}, "argument encoding failed"];
$self->_encode($enc, @_);
}
return !$self->error;
}
1;
}
sub _decode {
my $self = shift;
my $enc = shift;
local ($@, $SIG{__DIE__});
eval {
for (@_) {
defined or next;
$_ = $enc->decode($_, Encode::FB_CROAK());
}
};
$self->_check_eval_ok(OSSH_ENCODING_ERROR);
}
my @retriable = (Errno::EINTR(), Errno::EAGAIN());
push @retriable, Errno::EWOULDBLOCK() if Errno::EWOULDBLOCK() != Errno::EAGAIN();
sub _io3 {
my ($self, $out, $err, $in, $stdin_data, $timeout, $encoding) = @_;
# $self->wait_for_master or return;
my @data = _array_or_scalar_to_list $stdin_data;
my ($cout, $cerr, $cin) = (defined($out), defined($err), defined($in));
$timeout = $self->{_timeout} unless defined $timeout;
my $has_input = grep { defined and length } @data;
if ($cin and !$has_input) {
close $in;
undef $cin;
}
elsif (!$cin and $has_input) {
croak "remote input channel is not defined but data is available for sending"
}
my $enc = $self->_find_encoding($encoding);
if ($enc and @data) {
local $self->{_error_prefix} = [@{$self->{_error_prefix}}, "stdin data encoding failed"];
$self->_encode($enc, @data) if $has_input;
return if $self->error;
}
my $bout = '';
my $berr = '';
my ($fnoout, $fnoerr, $fnoin);
local $SIG{PIPE} = 'IGNORE';
MLOOP: while ($cout or $cerr or $cin) {
$debug and $debug & 64 and _debug "io3 mloop, cin: " . ($cin || 0) .
", cout: " . ($cout || 0) . ", cerr: " . ($cerr || 0);
my ($rv, $wv);
if ($cout or $cerr) {
$rv = '';
if ($cout) {
$fnoout = fileno $out;
vec($rv, $fnoout, 1) = 1;
}
if ($cerr) {
$fnoerr = fileno $err;
vec($rv, $fnoerr, 1) = 1
}
}
if ($cin) {
$fnoin = fileno $in;
$wv = '';
vec($wv, $fnoin, 1) = 1;
}
my $recalc_vecs;
FAST: until ($recalc_vecs) {
$debug and $debug & 64 and
_debug "io3 fast, cin: " . ($cin || 0) .
", cout: " . ($cout || 0) . ", cerr: " . ($cerr || 0);
my ($rv1, $wv1) = ($rv, $wv);
my $n = select ($rv1, $wv1, undef, $timeout);
if ($n > 0) {
if ($cout and vec($rv1, $fnoout, 1)) {
my $offset = length $bout;
my $read = sysread($out, $bout, 20480, $offset);
if ($debug and $debug & 64) {
_debug "stdout, bytes read: ", $read, " at offset $offset";
$read and $debug & 128 and _hexdump substr $bout, $offset;
}
unless ($read or grep $! == $_, @retriable) {
close $out;
undef $cout;
$recalc_vecs = 1;
}
}
if ($cerr and vec($rv1, $fnoerr, 1)) {
my $read = sysread($err, $berr, 20480, length($berr));
$debug and $debug & 64 and _debug "stderr, bytes read: ", $read;
unless ($read or grep $! == $_, @retriable) {
close $err;
undef $cerr;
$recalc_vecs = 1;
}
}
if ($cin and vec($wv1, $fnoin, 1)) {
my $written = syswrite($in, $data[0], 20480);
if ($debug and $debug & 64) {
_debug "stdin, bytes written: ", $written;
$written and $debug & 128 and _hexdump substr $data[0], 0, $written;
}
if ($written) {
substr($data[0], 0, $written, '');
while (@data) {
next FAST
if (defined $data[0] and length $data[0]);
shift @data;
}
# fallback when stdin queue is exhausted
}
elsif (grep $! == $_, @retriable) {
next FAST;
}
close $in;
undef $cin;
$recalc_vecs = 1;
}
}
else {
next if $n < 0 and grep $! == $_, @retriable;
$self->_set_error(OSSH_SLAVE_TIMEOUT, 'ssh slave failed', 'timed out');
last MLOOP;
}
}
}
close $out if $cout;
close $err if $cerr;
close $in if $cin;
if ($enc) {
local $self->{_error_prefix} = [@{$self->{_error_prefix}}, 'output decoding failed'];
unless ($self->_decode($enc, $bout, $berr)) {
undef $bout;
undef $berr;
}
}
$debug and $debug & 64 and _debug "leaving _io3()";
return ($bout, $berr);
}
_sub_options spawn => qw(stderr_to_stdout stdin_discard stdin_fh stdin_file stdout_discard
stdout_fh stdout_file stderr_discard stderr_fh stderr_file
stdinout_dpipe stdinout_dpipe_make_parent quote_args quote_args_extended remote_shell glob_quoting
tty ssh_opts tunnel encoding argument_encoding forward_agent forward_X11 setpgrp);
sub spawn {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
_croak_bad_options %opts;
return scalar $self->open_ex(\%opts, @_);
}
_sub_options open2 => qw(stderr_to_stdout stderr_discard stderr_fh stderr_file quote_args quote_args_extended
remote_shell glob_quoting tty ssh_opts tunnel encoding argument_encoding forward_agent
forward_X11 setpgrp);
sub open2 {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
_croak_bad_options %opts;
_croak_scalar_context;
my ($in, $out, undef, $pid) =
$self->open_ex({ stdout_pipe => 1,
stdin_pipe => 1,
%opts }, @_) or return ();
return ($in, $out, $pid);
}
_sub_options open2pty => qw(stderr_to_stdout stderr_discard stderr_fh stderr_file
quote_args quote_args_extended remote_shell glob_quoting tty
close_slave_pty ssh_opts encoding argument_encoding forward_agent
forward_X11 setpgrp);
sub open2pty {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
_croak_bad_options %opts;
my ($pty, undef, undef, $pid) =
$self->open_ex({ stdout_pty => 1,
stdin_pty => 1,
tty => 1,
%opts }, @_) or return ();
wantarray ? ($pty, $pid) : $pty;
}
_sub_options open2socket => qw(stderr_to_stdout stderr_discard stderr_fh stderr_file
quote_args quote_args_extended remote_shell glob_quoting tty
ssh_opts tunnel encoding argument_encoding forward_agent
forward_X11 setpgrp);
sub open2socket {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
_croak_bad_options %opts;
my ($socket, undef, undef, $pid) =
$self->open_ex({ stdinout_socket => 1,
%opts }, @_) or return ();
wantarray ? ($socket, $pid) : $socket;
}
_sub_options open3 => qw(quote_args quote_args_extended remote_shell glob_quoting tty ssh_opts
encoding argument_encoding forward_agent forward_X11 setpgrp);
sub open3 {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
_croak_bad_options %opts;
_croak_scalar_context;
my ($in, $out, $err, $pid) =
$self->open_ex({ stdout_pipe => 1,
stdin_pipe => 1,
stderr_pipe => 1,
%opts },
@_) or return ();
return ($in, $out, $err, $pid);
}
_sub_options open3pty => qw(quote_args quote_args_extended remote_shell glob_quoting tty close_slave_pty ssh_opts
encoding argument_encoding forward_agent forward_X11 setpgrp);
sub open3pty {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
_croak_bad_options %opts;
_croak_scalar_context;
my ($pty, undef, $err, $pid) =
$self->open_ex({ stdout_pty => 1,
stdin_pty => 1,
tty => 1,
stderr_pipe => 1,
%opts },
@_) or return ();
return ($pty, $err, $pid);
}
_sub_options open3socket => qw(quote_args quote_args_extended remote_shell glob_quoting tty ssh_opts encoding
argument_encoding forward_agent
forward_X11 setpgrp);
sub open3socket {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
_croak_bad_options %opts;
_croak_scalar_context;
my ($socket, undef, $err, $pid) =
$self->open_ex({ stdinout_socket => 1,
stderr_pipe => 1,
%opts }, @_) or return ();
return ($socket, $err, $pid);
}
_sub_options system => qw(stdout_discard stdout_fh stdin_discard stdout_file stdin_fh stdin_file
quote_args quote_args_extended remote_shell glob_quoting
stderr_to_stdout stderr_discard stderr_fh stderr_file
stdinout_dpipe stdinout_dpipe_make_parent tty ssh_opts tunnel encoding
argument_encoding forward_agent forward_X11 setpgrp);
sub system {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
my $stdin_data = delete $opts{stdin_data};
my $timeout = delete $opts{timeout};
my $async = delete $opts{async};
_croak_bad_options %opts;
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{CHLD};
my $stream_encoding;
if (defined $stdin_data) {
$opts{stdin_pipe} = 1;
$stream_encoding = $self->_delete_stream_encoding(\%opts);
}
my ($in, undef, undef, $pid) = $self->open_ex(\%opts, @_) or return undef;
$self->_io3(undef, undef, $in, $stdin_data, $timeout, $stream_encoding) if defined $stdin_data;
return $pid if $async;
$self->_waitpid($pid, $timeout);
}
_sub_options test => qw(stdout_discard stdout_fh stdin_discard stdout_file stdin_fh stdin_file
quote_args quote_args_extended remote_shell glob_quoting
stderr_to_stdout stderr_discard stderr_fh stderr_file
stdinout_dpipe stdinout_dpipe_make_parent tty ssh_opts timeout stdin_data
encoding stream_encoding argument_encoding forward_agent forward_X11 setpgrp);
sub test {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
$opts{stdout_discard} = 1 unless grep defined($opts{$_}), qw(stdout_discard stdout_fh
stdout_file stdinout_dpipe);
$opts{stderr_discard} = 1 unless grep defined($opts{$_}), qw(stderr_discard stderr_fh
stderr_file stderr_to_stdout);
_croak_bad_options %opts;
$self->system(\%opts, @_);
my $error = $self->error;
unless ($error) {
return 1;
}
if ($error == OSSH_SLAVE_CMD_FAILED) {
$self->_set_error(0);
return 0;
}
return undef;
}
_sub_options capture => qw(stderr_to_stdout stderr_discard stderr_fh stderr_file
stdin_discard stdin_fh stdin_file quote_args quote_args_extended
remote_shell glob_quoting tty ssh_opts tunnel
encoding argument_encoding forward_agent forward_X11 setpgrp);
sub capture {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
my $stdin_data = delete $opts{stdin_data};
my $timeout = delete $opts{timeout};
_croak_bad_options %opts;
my $stream_encoding = $self->_delete_stream_encoding(\%opts);
$opts{stdout_pipe} = 1;
$opts{stdin_pipe} = 1 if defined $stdin_data;
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{CHLD};
my ($in, $out, undef, $pid) = $self->open_ex(\%opts, @_) or return ();
my ($output) = $self->_io3($out, undef, $in, $stdin_data, $timeout, $stream_encoding);
$self->_waitpid($pid, $timeout);
if (wantarray) {
my $pattern = quotemeta $/;
return split /(?<=$pattern)/, $output;
}
$output
}
_sub_options capture2 => qw(stdin_discard stdin_fh stdin_file
quote_args quote_args_extended remote_shell glob_quoting
tty ssh_opts encoding stream_encoding
argument_encoding forward_agent forward_X11 setpgrp);
sub capture2 {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
my $stdin_data = delete $opts{stdin_data};
my $timeout = delete $opts{timeout};
_croak_bad_options %opts;
my $stream_encoding = $self->_delete_stream_encoding(\%opts);
$opts{stdout_pipe} = 1;
$opts{stderr_pipe} = 1;
$opts{stdin_pipe} = 1 if defined $stdin_data;
local $SIG{INT} = 'IGNORE';
local $SIG{QUIT} = 'IGNORE';
local $SIG{CHLD};
my ($in, $out, $err, $pid) = $self->open_ex( \%opts, @_) or return ();
my @capture = $self->_io3($out, $err, $in, $stdin_data, $timeout, $stream_encoding);
$self->_waitpid($pid, $timeout);
wantarray ? @capture : $capture[0];
}
_sub_options open_tunnel => qw(ssh_opts stderr_discard stderr_fh stderr_file
encoding argument_encoding forward_agent setpgrp);
sub open_tunnel {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
$opts{stderr_discard} = 1 unless grep defined $opts{$_}, qw(stderr_discard stderr_fh stderr_file);
_croak_bad_options %opts;
@_ == 2 or croak 'Usage: $ssh->open_tunnel(\%opts, $host, $port)';
$opts{tunnel} = 1;
$self->open2socket(\%opts, @_);
}
_sub_options capture_tunnel => qw(ssh_opts stderr_discard stderr_fh stderr_file stdin_discard
stdin_fh stdin_file stdin_data timeout encoding stream_encoding
argument_encoding forward_agent setpgrp);
sub capture_tunnel {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
$opts{stderr_discard} = 1 unless grep defined $opts{$_}, qw(stderr_discard stderr_fh stderr_file);
_croak_bad_options %opts;
@_ == 2 or croak 'Usage: $ssh->capture_tunnel(\%opts, $host, $port)';
$opts{tunnel} = 1;
$self->capture(\%opts, @_);
}
sub _calling_method {
my $method = (caller 2)[3];
$method =~ s/.*:://;
$method;
}
sub _scp_get_args {
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
@_ > 0 or croak
'Usage: $ssh->' . _calling_method . '(\%opts, $remote_fn1, $remote_fn2, ..., $local_fn_or_dir)';
my $glob = delete $opts{glob};
my $target = (@_ > 1 ? pop @_ : '.');
$target =~ m|^[^/]*:| and $target = "./$target";
my $prefix = $self->{_host_squared};
$prefix = "$self->{_user}\@$prefix" if defined $self->{_user};
my $src = "$prefix:". join(" ", $self->_quote_args({quote_args => 1,
glob_quoting => $glob},
@_));
($self, \%opts, $target, $src);
}
sub scp_get {
${^TAINT} and &_catch_tainted_args;
my ($self, $opts, $target, @src) = _scp_get_args @_;
$self->_scp($opts, @src, $target);
}
sub rsync_get {
${^TAINT} and &_catch_tainted_args;
my ($self, $opts, $target, @src) = _scp_get_args @_;
$self->_rsync($opts, @src, $target);
}
sub _scp_put_args {
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
@_ > 0 or croak
'Usage: $ssh->' . _calling_method . '(\%opts, $local_fn1, $local_fn2, ..., $remote_dir_or_fn)';
my $glob = delete $opts{glob};
my $glob_flags = ($glob ? delete $opts{glob_flags} || 0 : undef);
my $prefix = $self->{_host_squared};
$prefix = "$self->{_user}\@$prefix" if defined $self->{_user};
my $remote_shell = delete $opts{remote_shell};
my $target = $prefix . ':' . ( @_ > 1
? $self->_quote_args({quote_args => 1, remote_shell => $remote_shell}, pop(@_))
: '');
my @src = @_;
if ($glob) {
require File::Glob;
@src = map File::Glob::bsd_glob($_, $glob_flags), @src;
unless (@src) {
$self->_set_error(OSSH_SLAVE_FAILED,
"given file name patterns did not match any file");
return undef;
}
}
$_ = "./$_" for grep m|^[^/]*:|, @src;
($self, \%opts, $target, @src);
}
sub scp_put {
${^TAINT} and &_catch_tainted_args;
my ($self, $opts, $target, @src) = _scp_put_args @_;
return unless $self;
$self->_scp($opts, @src, $target);
}
sub rsync_put {
${^TAINT} and &_catch_tainted_args;
my ($self, $opts, $target, @src) = _scp_put_args @_;
return unless $self;
$self->_rsync($opts, @src, $target);
}
_sub_options _scp => qw(stderr_to_stdout stderr_discard stderr_fh
stderr_file stdout_discard stdout_fh
stdout_file encoding argument_encoding
forward_agent setpgrp);
sub _scp {
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
my $quiet = delete $opts{quiet};
$quiet = 1 unless defined $quiet;
my $recursive = delete $opts{recursive};
my $copy_attrs = delete $opts{copy_attrs};
my $bwlimit = delete $opts{bwlimit};
my $async = delete $opts{async};
my $ssh_opts = delete $opts{ssh_opts};
my $timeout = delete $opts{timeout};
my $verbose = delete $opts{verbose};
_croak_bad_options %opts;
my @opts;
@opts = @$ssh_opts if $ssh_opts;
push @opts, '-q' if $quiet;
push @opts, '-v' if $verbose;
push @opts, '-r' if $recursive;
push @opts, '-p' if $copy_attrs;
push @opts, '-l', $bwlimit if $bwlimit;
local $self->{_error_prefix} = [@{$self->{_error_prefix}}, 'scp failed'];
my $pid = $self->open_ex({ %opts,
_cmd => 'scp',
ssh_opts => \@opts,
quote_args => 0 },
@_);
return $pid if $async;
$self->_waitpid($pid, $timeout);
}
my %rsync_opt_with_arg = map { $_ => 1 } qw(chmod suffix backup-dir rsync-path max-delete max-size min-size partial-dir
timeout modify-window temp-dir compare-dest copy-dest link-dest compress-level
skip-compress filter exclude exclude-from include include-from
out-format log-file log-file-format bwlimit protocol iconv checksum-seed);
my %rsync_opt_forbidden = map { $_ => 1 } qw(rsh address port sockopts blocking-io password-file write-batch
only-write-batch read-batch ipv4 ipv6 version help daemon config detach
files-from from0 blocking-io protect-args list-only);
$rsync_opt_forbidden{"no-$_"} = 1 for (keys %rsync_opt_with_arg, keys %rsync_opt_forbidden);
my %rsync_error = (1, 'syntax or usage error',
2, 'protocol incompatibility',
3, 'errors selecting input/output files, dirs',
4, 'requested action not supported: an attempt was made to manipulate 64-bit files on a platform '.
'that cannot support them; or an option was specified that is supported by the client and not '.
'by the server.',
5, 'error starting client-server protocol',
6, 'daemon unable to append to log-file',
10, 'error in socket I/O',
11, 'error in file I/O',
12, 'error in rsync protocol data stream',
13, 'errors with program diagnostics',
14, 'error in IPC code',
20, 'received SIGUSR1 or SIGINT',
21, 'some error returned by waitpid()',
22, 'error allocating core memory buffers',
23, 'partial transfer due to error',
24, 'partial transfer due to vanished source files',
25, 'the --max-delete limit stopped deletions',
30, 'timeout in data send/receive',
35, 'timeout waiting for daemon connection');
my %rsync_opt_open_ex = map { $_ => 1 } qw(stderr_to_stdout
stderr_discard stderr_fh
stderr_file stdout_discard
stdout_fh stdout_file encoding
argument_encoding);
sub _rsync {
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
my $async = delete $opts{async};
my $verbose = delete $opts{verbose};
my $quiet = delete $opts{quiet};
my $copy_attrs = delete $opts{copy_attrs};
my $timeout = delete $opts{timeout};
$quiet = 1 unless (defined $quiet or $verbose);
my @opts = qw(--blocking-io) ;
push @opts, '-q' if $quiet;
push @opts, '-pt' if $copy_attrs;
push @opts, '-' . ($verbose =~ /^\d+$/ ? 'v' x $verbose : 'v') if $verbose;
my %opts_open_ex = ( _cmd => 'rsync',
quote_args => 0 );
for my $opt (keys %opts) {
my $value = $opts{$opt};
if (defined $value) {
if ($rsync_opt_open_ex{$opt}) {
$opts_open_ex{$opt} = $value;
}
else {
my $opt1 = $opt;
$opt1 =~ tr/_/-/;
$rsync_opt_forbidden{$opt1} and croak "forbidden rsync option '$opt' used";
if ($rsync_opt_with_arg{$opt1}) {
push @opts, "--$opt1=$_" for _array_or_scalar_to_list($value)
}
else {
$value = !$value if $opt1 =~ s/^no-//;
push @opts, ($value ? "--$opt1" : "--no-$opt1");
}
}
}
}
local $self->{_error_prefix} = [@{$self->{_error_prefix}}, 'rsync failed'];
my $pid = $self->open_ex(\%opts_open_ex, @opts, '--', @_);
return $pid if $async;
$self->_waitpid($pid, $timeout) and return 1;
if ($self->error == OSSH_SLAVE_CMD_FAILED and $?) {
my $err = ($? >> 8);
my $errstr = $rsync_error{$err};
$errstr = 'Unknown rsync error' unless defined $errstr;
my $signal = $? & 255;
my $signalstr = ($signal ? " (signal $signal)" : '');
$self->_set_error(OSSH_SLAVE_CMD_FAILED,
"command exited with code $err$signalstr: $errstr");
}
return undef
}
_sub_options sftp => qw(autoflush timeout argument_encoding encoding block_size queue_size autodie
late_set_perm forward_agent setpgrp min_block_size read_ahead write_delay
dirty_cleanup remote_has_volumes autodisconnect more);
sub sftp {
${^TAINT} and &_catch_tainted_args;
@_ & 1 or croak 'Usage: $ssh->sftp(%sftp_opts)';
_load_module('Net::SFTP::Foreign', '1.47');
my ($self, %opts) = @_;
my $stderr_fh = delete $opts{stderr_fh};
my $stderr_discard = delete $opts{stderr_discard};
my $fs_encoding = _first_defined(delete $opts{fs_encoding},
$opts{argument_encoding},
$opts{encoding},
$self->{_default_argument_encoding});
undef $fs_encoding if (defined $fs_encoding and $fs_encoding eq 'bytes');
_croak_bad_options %opts;
$opts{timeout} = $self->{_timeout} unless defined $opts{timeout};
$self->wait_for_master or return undef;
my ($in, $out, $pid) = $self->open2( { ssh_opts => '-s',
stderr_fh => $stderr_fh,
stderr_discard => $stderr_discard },
'sftp' )
or return undef;
my $sftp = Net::SFTP::Foreign->new(transport => [$out, $in, $pid],
dirty_cleanup => 0,
fs_encoding => $fs_encoding,
%opts);
if ($sftp->error) {
$self->_or_set_error(OSSH_SLAVE_SFTP_FAILED, "unable to create SFTP client", $sftp->error);
return undef;
}
$sftp
}
_sub_options sshfs_import => qw(stderr_discard stderr_fh stderr_file
ssh_opts argument_encoding sshfs_opts setpgrp);
sub sshfs_import {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
@_ == 2 or croak 'Usage: $ssh->sshfs_import(\%opts, $remote, $local)';
my ($from, $to) = @_;
my @sshfs_opts = ( -o => 'slave',
_array_or_scalar_to_list delete $opts{sshfs_opts} );
_croak_bad_options %opts;
$opts{ssh_opts} = ['-s', _array_or_scalar_to_list delete $opts{ssh_opts}];
$opts{stdinout_dpipe} = [$self->{_sshfs_cmd}, "$self->{_host_squared}:$from", $to, @sshfs_opts];
$opts{stdinout_dpipe_make_parent} = 1;
$self->spawn(\%opts, 'sftp');
}
_sub_options sshfs_export => qw(stderr_discard stderr_fh stderr_file
ssh_opts argument_encoding sshfs_opts setpgrp);
sub sshfs_export {
${^TAINT} and &_catch_tainted_args;
my $self = shift;
my %opts = (ref $_[0] eq 'HASH' ? %{shift()} : ());
@_ == 2 or croak 'Usage: $ssh->sshfs_export(\%opts, $local, $remote)';
my ($from, $to) = @_;
my @sshfs_opts = ( -o => 'slave',
_array_or_scalar_to_list delete $opts{sshfs_opts} );
_croak_bad_options %opts;
$opts{stdinout_dpipe} = $self->{_sftp_server_cmd};
my $hostname = do {
local ($@, $SIG{__DIE__});
eval {
require Sys::Hostname;
Sys::Hostname::hostname();
};
};
$hostname = 'remote' if (not defined $hostname or
not length $hostname or
$hostname=~/^localhost\b/);
$self->spawn(\%opts, $self->{_sshfs_cmd}, "$hostname:$from", $to, @sshfs_opts);
}
sub object_remote {
my $self = shift;
_load_module('Object::Remote') or return;
_load_module('Net::OpenSSH::ObjectRemote') or return;
my $connector = Net::OpenSSH::ObjectRemote->new(net_openssh => $self);
$connector->connect(@_);
}
sub any {
my $self = shift;
_load_module('Net::SSH::Any');
Net::SSH::Any->new($self->{_host}, user => $self->{_user}, port => $self->{_port},
backend => 'Net_OpenSSH',
backend_opts => { Net_OpenSSH => { instance => $self } });
}
sub DESTROY {
my $self = shift;
$debug and $debug & 2 and _debug("DESTROY($self, pid: ", $self->{_pid}, ")");
local ($SIG{__DIE__}, $@, $?, $!);
$self->_disconnect;
}
1;
__END__
=head1 NAME
Net::OpenSSH - Perl SSH client package implemented on top of OpenSSH
=head1 SYNOPSIS
use Net::OpenSSH;
my $ssh = Net::OpenSSH->new($host);
$ssh->error and
die "Couldn't establish SSH connection: ". $ssh->error;
$ssh->system("ls /tmp") or
die "remote command failed: " . $ssh->error;
my @ls = $ssh->capture("ls");
$ssh->error and
die "remote ls command failed: " . $ssh->error;
my ($out, $err) = $ssh->capture2("find /root");
$ssh->error and
die "remote find command failed: " . $ssh->error;
my ($rin, $pid) = $ssh->pipe_in("cat >/tmp/foo") or
die "pipe_in method failed: " . $ssh->error;
print $rin "hello\n";
close $rin;
my ($rout, $pid) = $ssh->pipe_out("cat /tmp/foo") or
die "pipe_out method failed: " . $ssh->error;
while (<$rout>) { print }
close $rout;
my ($in, $out ,$pid) = $ssh->open2("foo");
my ($pty, $pid) = $ssh->open2pty("foo");
my ($in, $out, $err, $pid) = $ssh->open3("foo");
my ($pty, $err, $pid) = $ssh->open3pty("login");
my $sftp = $ssh->sftp();
$sftp->error and die "SFTP failed: " . $sftp->error;
=head1 DESCRIPTION
Net::OpenSSH is a secure shell client package implemented on top of
OpenSSH binary client (C<ssh>).
=head2 Under the hood
This package is implemented around the multiplexing feature found in
later versions of OpenSSH. That feature allows one to run several
sessions over a single SSH connection (OpenSSH 4.1 was the first
one to provide all the required functionality).
When a new Net::OpenSSH object is created, the OpenSSH C<ssh> client
is run in master mode, establishing a persistent (for the lifetime of
the object) connection to the server.
Then, every time a new operation is requested a new C<ssh> process is
started in slave mode, effectively reusing the master SSH connection
to send the request to the remote side.
=head2 Net::OpenSSH Vs. Net::SSH::.* modules
Why should you use Net::OpenSSH instead of any of the other Perl SSH
clients available?
Well, this is my (biased) opinion:
L<Net::SSH::Perl|Net::SSH::Perl> is not well maintained nowadays
(update: a new maintainer has stepped in so this situation could
change!!!), requires a bunch of modules (some of them very difficult
to install) to be acceptably efficient and has an API that is limited
in some ways.
L<Net::SSH2|Net::SSH2> is much better than Net::SSH::Perl, but not
completely stable yet. It can be very difficult to install on some
specific operating systems and its API is also limited, in the same
way as L<Net::SSH::Perl|Net::SSH::Perl>.
Using L<Net::SSH::Expect|Net::SSH::Expect>, in general, is a bad
idea. Handling interaction with a shell via Expect in a generic way
just can not be reliably done.
Net::SSH is just a wrapper around any SSH binary commands available on
the machine. It can be very slow as they establish a new SSH
connection for every operation performed.
In comparison, Net::OpenSSH is a pure perl module that does not have
any mandatory dependencies (obviously, besides requiring OpenSSH
binaries).
Net::OpenSSH has a very perlish interface. Most operations are
performed in a fashion very similar to that of the Perl builtins and
common modules (e.g. L<IPC::Open2|IPC::Open2>).
It is also very fast. The overhead introduced by launching a new ssh
process for every operation is not appreciable (at least on my Linux
box). The bottleneck is the latency intrinsic to the protocol, so
Net::OpenSSH is probably as fast as an SSH client can be.
Being based on OpenSSH is also an advantage: a proved, stable, secure
(to paranoid levels), inseparably and well maintained implementation
of the SSH protocol is used.
On the other hand, Net::OpenSSH does not work on Windows, not even
under Cygwin.
Net::OpenSSH specifically requires the OpenSSH SSH client (AFAIK, the
multiplexing feature is not available from any other SSH
client). However, note that it will interact with any server software,
not just servers running OpenSSH C<sshd>.
For password authentication, L<IO::Pty|IO::Pty> has to be
installed. Other modules and binaries are also required to implement
specific functionality (for instance
L<Net::SFTP::Foreign|Net::SFTP::Foreign>, L<Expect|Expect> or
L<rsync(1)|rsync(1)>).
Net::OpenSSH and Net::SSH2 do not support version 1 of the SSH
protocol.
=head1 API
=head2 Optional arguments
Almost all methods in this package accept as first argument an
optional reference to a hash containing parameters (C<\%opts>). For
instance, these two method calls are equivalent:
my $out1 = $ssh->capture(@cmd);
my $out2 = $ssh->capture({}, @cmd);
=head2 Error handling
Most methods return undef (or an empty list) to indicate failure.
The L</error> method can always be used to explicitly check for
errors. For instance:
my ($output, $errput) = $ssh->capture2({timeout => 1}, "find /");
$ssh->error and die "ssh failed: " . $ssh->error;
=head2 Net::OpenSSH methods
These are the methods provided by the package:
=over 4
=item Net::OpenSSH->new($host, %opts)
Creates a new SSH master connection
C<$host> can be a hostname or an IP address. It may also
contain the name of the user, her password and the TCP port
number where the server is listening:
my $ssh1 = Net::OpenSSH->new('jack@foo.bar.com');
my $ssh2 = Net::OpenSSH->new('jack:secret@foo.bar.com:10022');
my $ssh3 = Net::OpenSSH->new('jsmith@2001:db8::1428:57ab'); # IPv6
IPv6 addresses may optionally be enclosed in brackets:
my $ssh4 = Net::OpenSSH->new('jsmith@[::1]:1022');
This method always succeeds in returning a new object. Error checking
has to be performed explicitly afterwards:
my $ssh = Net::OpenSSH->new($host, %opts);
$ssh->error and die "Can't ssh to $host: " . $ssh->error;
If you have problems getting Net::OpenSSH to connect to the remote
host read the troubleshooting chapter near the end of this document.
Accepted options:
=over 4
=item user => $user_name
Login name
=item port => $port
TCP port number where the server is running
=item password => $password
User given password for authentication.
Note that using password authentication in automated scripts is a very
bad idea. When possible, you should use public key authentication
instead.
=item passphrase => $passphrase
X<passphrase>Uses given passphrase to open private key.
=item key_path => $private_key_path
Uses the key stored on the given file path for authentication.
=item gateway => $gateway
If the given argument is a gateway object as returned by
L<Net::OpenSSH::Gateway/find_gateway> method, use it to connect to
the remote host.
If it is a hash reference, call the C<find_gateway> method first.
For instance, the following code fragments are equivalent:
my $gateway = Net::OpenSSH::Gateway->find_gateway(
proxy => 'http://proxy.corporate.com');
$ssh = Net::OpenSSH->new($host, gateway => $gateway);
and
$ssh = Net::OpenSSH->new($host,
gateway => { proxy => 'http://proxy.corporate.com'});
=item proxy_command => $proxy_command
Use the given command to establish the connection to the remote host
(see C<ProxyCommand> on L<ssh_config(5)>).
=item batch_mode => 1
Disables querying the user for password and passphrases.
=item ctl_dir => $path
Directory where the SSH master control socket will be created.
This directory and its parents must be writable only by the current
effective user or root, otherwise the connection will be aborted to
avoid insecure operation.
By default C<~/.libnet-openssh-perl> is used.
=item ssh_cmd => $cmd
Name or full path to OpenSSH C<ssh> binary. For instance:
my $ssh = Net::OpenSSH->new($host, ssh_cmd => '/opt/OpenSSH/bin/ssh');
=item scp_cmd => $cmd
Name or full path to OpenSSH C<scp> binary.
By default it is inferred from the C<ssh> one.
=item rsync_cmd => $cmd
Name or full path to C<rsync> binary. Defaults to C<rsync>.
=item remote_shell => $name
Name of the remote shell. Used to select the argument quoter backend.
=item timeout => $timeout
Maximum acceptable time that can elapse without network traffic or any
other event happening on methods that are not immediate (for instance,
when establishing the master SSH connection or inside methods
C<capture>, C<system>, C<scp_get>, etc.).
See also L</Timeouts>.
=item kill_ssh_on_timeout => 1
This option tells Net::OpenSSH to kill the local slave SSH process
when some operation times out.
See also L</Timeouts>.
=item strict_mode => 0
By default, the connection will be aborted if the path to the socket
used for multiplexing is found to be non-secure (for instance, when
any of the parent directories is writable by other users).
This option can be used to disable that feature. Use with care!!!
=item async => 1
By default, the constructor waits until the multiplexing socket is
available. That option can be used to defer the waiting until the
socket is actually used.
For instance, the following code connects to several remote machines
in parallel:
my (%ssh, %ls);
# multiple connections are established in parallel:
for my $host (@hosts) {
$ssh{$host} = Net::OpenSSH->new($host, async => 1);
}
# then to run some command in all the hosts (sequentially):
for my $host (@hosts) {
$ssh{$host}->system('ls /');
}
=item connect => 0
Do not launch the master SSH process yet.
=item master_opts => [...]
Additional options to pass to the C<ssh> command when establishing the
master connection. For instance:
my $ssh = Net::OpenSSH->new($host,
master_opts => [-o => "ProxyCommand corkscrew httpproxy 8080 $host"]);
=item default_ssh_opts => [...]
Default slave SSH command line options for L</open_ex> and derived
methods.
For instance:
my $ssh = Net::OpenSSH->new($host,
default_ssh_opts => [-o => "ConnectionAttempts=0"]);
=item forward_agent => 1
Enables forwarding of the authentication agent.
This option can not be used when passing a passphrase (via
L</passphrase>) to unlock the login private key.
Note that Net::OpenSSH will not run C<ssh-agent> for you. This has to
be done ahead of time and the environment variable C<SSH_AUTH_SOCK>
set pointing to the proper place.
=item forward_X11 => 1
Enables forwarding of the X11 protocol
=item default_stdin_fh => $fh
=item default_stdout_fh => $fh
=item default_stderr_fh => $fh
Default I/O streams for L</open_ex> and derived methods (currently, that
means any method but L</pipe_in> and L</pipe_out> and I plan to remove
those exceptions soon!).
For instance:
open my $stderr_fh, '>>', '/tmp/$host.err' or die ...;
open my $stdout_fh, '>>', '/tmp/$host.log' or die ...;
my $ssh = Net::OpenSSH->new($host, default_stderr_fh => $stderr_fh,
default_stdout_fh => $stdout_fh);
$ssh->error and die "SSH connection failed: " . $ssh->error;
$ssh->scp_put("/foo/bar*", "/tmp")
or die "scp failed: " . $ssh->error;
=item default_stdin_file = $fn
=item default_stdout_file = $fn
=item default_stderr_file = $fn
Opens the given file names and use them as the defaults.
=item master_stdout_fh => $fh
=item master_stderr_fh => $fh
Redirect corresponding stdio streams of the master SSH process to
given filehandles.
=item master_stdout_discard => $bool
=item master_stderr_discard => $bool
Discard corresponding stdio streams.
=item expand_vars => $bool
Activates variable expansion inside command arguments and file paths.
See L</"Variable expansion"> below.
=item vars => \%vars
Initial set of variables.
=item external_master => 1
Instead of launching a new OpenSSH client in master mode, the module
tries to reuse an already existent one. C<ctl_path> must also be
passed when this option is set. See also L</get_ctl_path>.
Example:
$ssh = Net::OpenSSH->new('foo', external_master => 1, ctl_path = $path);
When C<external_master> is set, the hostname argument becomes optional
(C<0.0.0.0> is passed to OpenSSH which does not use it at all).
=item default_encoding => $encoding
=item default_stream_encoding => $encoding
=item default_argument_encoding => $encoding
Set default encodings. See L</Data encoding>.
=item password_prompt => $string
=item password_prompt => $re
By default, when using password authentication, the module expects the
remote side to send a password prompt matching C</[?:]/>.
This option can be used to override that default for the rare cases
when a different prompt is used.
Examples:
password_prompt => ']'; # no need to escape ']'
password_prompt => qr/[:?>]/;
=item login_handler => \&custom_login_handler
Some remote SSH server may require a custom login/authentication
interaction not natively supported by Net::OpenSSH. In that cases, you
can use this option to replace the default login logic.
The callback will be invoked repeatedly as C<custom_login_handler($ssh,
$pty, $data)> where C<$ssh> is the current Net::OpenSSH object, C<pty>
a L<IO::Pty> object attached to the slave C<ssh> process tty and
C<$data> a reference to an scalar you can use at will.
The login handler must return 1 after the login process has completed
successfully or 0 in case it still needs to do something else. If some
error happens, it must die.
Note, that blocking operations should not be performed inside the
login handler (at least if you want the C<async> and C<timeout>
features to work).
See also the sample script C<login_handler.pl> in the C<samples>
directory.
Usage of this option is incompatible with the C<password> and
C<passphrase> options, you will have to handle password or passphrases
from the custom handler yourself.
=item master_setpgrp => 1
When this option is set, the master process is run as a different
process group. As a consequence it will not die when the user presses
Ctrl-C at the terminal.
In order to allow the master SSH process to request any information
from the user, the module may set it as the terminal controlling
process while the connection is established (using
L<POSIX/tcsetpgrp>). Afterwards, the terminal controlling process is
reset.
This feature is highly experimental. Report any problems you may find,
please.
=back
=item $ssh->error
Returns the error condition for the last performed operation.
The returned value is a dualvar as $! (see L<perlvar/"$!">) that
renders an informative message when used in string context or an error
number in numeric context (error codes appear in
L<Net::OpenSSH::Constants|Net::OpenSSH::Constants>).
=item $ssh->get_user
=item $ssh->get_host
=item $ssh->get_port
Return the corresponding SSH login parameters.
=item $ssh->get_ctl_path
X<get_ctl_path>Returns the path to the socket where the OpenSSH master
process listens for new multiplexed connections.
=item ($in, $out, $err, $pid) = $ssh->open_ex(\%opts, @cmd)
X<open_ex>I<Note: this is a low level method which, probably, you do
not need to use!>
That method starts the command C<@cmd> on the remote machine creating
new pipes for the IO channels as specified on the C<%opts> hash.
If C<@cmd> is omitted, the remote user shell is run.
Returns four values, the first three (C<$in>, C<$out> and C<$err>)
correspond to the local side of the pipes created (they can be undef)
and the fourth (C<$pid>) to the PID of the new SSH slave process. An
empty list is returned on failure.
Note that C<waitpid> has to be used afterwards to reap the
slave SSH process.
Accepted options:
=over 4
=item stdin_pipe => 1
Creates a new pipe and connects the reading side to the stdin stream
of the remote process. The writing side is returned as the first
value (C<$in>).
=item stdin_pty => 1
Similar to C<stdin_pipe>, but instead of a regular pipe it uses a
pseudo-tty (pty).
Note that on some operating systems (e.g. HP-UX, AIX), ttys are not
reliable. They can overflow when large chunks are written or when data
is written faster than it is read.
=item stdin_fh => $fh
Duplicates C<$fh> and uses it as the stdin stream of the remote process.
=item stdin_file => $filename
=item stdin_file => \@open_args
Opens the file of the given name for reading and uses it as the remote
process stdin stream.
If an array reference is passed its contents are used as the arguments
for the underlying open call. For instance:
$ssh->system({stdin_file => ['-|', 'gzip -c -d file.gz']}, $rcmd);
=item stdin_discard => 1
Uses /dev/null as the remote process stdin stream.
=item stdout_pipe => 1
Creates a new pipe and connects the writing side to the stdout stream
of the remote process. The reading side is returned as the second
value (C<$out>).
=item stdout_pty => 1
Connects the stdout stream of the remote process to the
pseudo-pty. This option requires C<stdin_pty> to be also set.
=item stdout_fh => $fh
Duplicates C<$fh> and uses it as the stdout stream of the remote
process.
=item stdout_file => $filename
=item stdout_file => \@open_args
Opens the file of the given filename and redirect stdout there.
=item stdout_discard => 1
Uses /dev/null as the remote process stdout stream.
=item stdinout_socket => 1
Creates a new socketpair, attaches the stdin an stdout streams of the
slave SSH process to one end and returns the other as the first value
(C<$in>) and undef for the second (C<$out>).
Example:
my ($socket, undef, undef, $pid) = $ssh->open_ex({stdinout_socket => 1},
'/bin/netcat $dest');
See also L</open2socket>.
=item stdinout_dpipe => $cmd
=item stdinout_dpipe => \@cmd
Runs the given command locally attaching its stdio streams to those of
the remote SSH command. Conceptually it is equivalent to the
L<dpipe(1)> shell command.
=item stderr_pipe => 1
Creates a new pipe and connects the writing side to the stderr stream
of the remote process. The reading side is returned as the third
value (C<$err>).
Example:
my $pid = $ssh->open_ex({stdinout_dpipe => 'vncviewer -stdio'},
x11vnc => '-inetd');
=item stderr_fh => $fh
Duplicates C<$fh> and uses it as the stderr stream of the remote process.
=item stderr_file => $filename
Opens the file of the given name and redirects stderr there.
=item stderr_to_stdout => 1
Makes stderr point to stdout.
=item tty => $bool
Tells C<ssh> to allocate a pseudo-tty for the remote process. By
default, a tty is allocated if remote command stdin stream is attached
to a tty.
When this flag is set and stdin is not attached to a tty, the ssh
master and slave processes may generate spurious warnings about failed
tty operations. This is caused by a bug present in older versions of
OpenSSH.
=item close_slave_pty => 0
When a pseudo pty is used for the stdin stream, the slave side is
automatically closed on the parent process after forking the ssh
command.
This option disables that feature, so that the slave pty can be
accessed on the parent process as C<$pty-E<gt>slave>. It will have to
be explicitly closed (see L<IO::Pty|IO::Pty>)
=item quote_args => $bool
See L</"Shell quoting"> below.
=item remote_shell => $shell
Sets the remote shell. Allows one to change the argument quoting
mechanism in a per-command fashion.
This may be useful when interacting with a Windows machine where
argument parsing may be done at the command level in custom ways.
Example:
$ssh->system({remote_shell => 'MSWin'}, echo => $line);
$ssh->system({remote_shell => 'MSCmd,MSWin'}, type => $file);
=item forward_agent => $bool
Enables/disables forwarding of the authentication agent.
This option can only be used when agent forwarding has been previously
requested on the constructor.
=item forward_X11 => $bool
Enables/disables forwarding of the X11 protocol.
This option can only be used when X11 forwarding has been previously
requested on the constructor.
=item ssh_opts => \@opts
List of extra options for the C<ssh> command.
This feature should be used with care, as the given options are not
checked in any way by the module, and they could interfere with it.
=item tunnel => $bool
Instead of executing a command in the remote host, this option
instruct Net::OpenSSH to create a TCP tunnel. The arguments become the
target IP and port or the remote path for an Unix socket.
Example:
my ($in, $out, undef, $pid) = $ssh->open_ex({tunnel => 1}, $IP, $port);
my ($in, $out, undef, $pid) = $ssh->open_ex({tunnel => 1}, $socket_path);
See also L</Tunnels>.
=item encoding => $encoding
=item argument_encoding => $encoding
Set encodings. See L</Data encoding>.
=back
Usage example:
# similar to IPC::Open2 open2 function:
my ($in_pipe, $out_pipe, undef, $pid) =
$ssh->open_ex( { stdin_pipe => 1,
stdout_pipe => 1 },
@cmd )
or die "open_ex failed: " . $ssh->error;
# do some IO through $in/$out
# ...
waitpid($pid);
=item setpgrp => 1
Calls C<setpgrp> after forking the child process. As a result it will
not die when the user presses Ctrl+C at the console. See also
L<perlfunc/setpgrp>.
Using this option without also setting C<master_setpgrp> on the
constructor call is mostly useless as the signal will be delivered to
the master process and all the remote commands aborted.
This feature is experimental.
=item $ssh->system(\%opts, @cmd)
Runs the command C<@cmd> on the remote machine.
Returns true on success, undef otherwise.
The error status is set to C<OSSH_SLAVE_CMD_FAILED> when the remote
command exits with a non zero code (the code is available from C<$?>,
see L<perlvar/"$?">).
Example:
$ssh->system('ls -R /')
or die "ls failed: " . $ssh->error";
As for C<system> builtin, C<SIGINT> and C<SIGQUIT> signals are
blocked. (see L<perlfunc/system>). Also, setting C<$SIG{CHLD}> to
C<IGNORE> or to a custom signal handler will interfere with this
method.
Accepted options:
=over 4
=item stdin_data => $input
=item stdin_data => \@input
Sends the given data through the stdin stream to the remote
process.
For example, the following code creates a file on the remote side:
$ssh->system({stdin_data => \@data}, "cat >/tmp/foo")
or die "unable to write file: " . $ssh->error;
=item timeout => $timeout
The operation is aborted after C<$timeout> seconds elapsed without
network activity.
See also L</Timeouts>.
=item async => 1
Does not wait for the child process to exit. The PID of the new
process is returned.
Note that when this option is combined with C<stdin_data>, the given
data will be transferred to the remote side before returning control
to the caller.
See also the L</spawn> method documentation below.
=item stdin_fh => $fh
=item stdin_discard => $bool
=item stdout_fh => $fh
=item stdout_discard => $bool
=item stderr_fh => $fh
=item stderr_discard => $bool
=item stderr_to_stdout => $bool
=item stdinout_dpipe => $cmd
=item tty => $bool
See the L</open_ex> method documentation for an explanation of these
options.
=back
=item $ok = $ssh->test(\%opts, @cmd);
Runs the given command and returns its success/failure exit status as
1 or 0 respectively. Returns undef when something goes wrong in the
SSH layer.
Error status is not set to OSSH_SLAVE_CMD_FAILED when the remote
command exits with a non-zero code.
By default this method discards the remote command C<stdout> and
C<sterr> streams.
Usage example:
if ($ssh->test(ps => -C => $executable)) {
say "$executable is running on remote machine"
}
else {
die "something got wrong: ". $ssh->error if $ssh->error;
say "$executable is not running on remote machine"
}
This method support the same set of options as C<system>, except
C<async> and C<tunnel>.
=item $output = $ssh->capture(\%opts, @cmd);
=item @output = $ssh->capture(\%opts, @cmd);
This method is conceptually equivalent to the perl backquote operator
(e.g. C<`ls`>): it runs the command on the remote machine and captures
its output.
In scalar context returns the output as a scalar. In list context
returns the output broken into lines (it honors C<$/>, see
L<perlvar/"$/">).
The exit status of the remote command is returned in C<$?>.
When an error happens while capturing (for instance, the operation
times out), the partial captured output will be returned. Error
conditions have to be explicitly checked using the L</error>
method. For instance:
my $output = $ssh->capture({ timeout => 10 },
"echo hello; sleep 20; echo bye");
$ssh->error and
warn "operation didn't complete successfully: ". $ssh->error;
print $output;
Setting C<$SIG{CHLD}> to a custom signal handler or to C<IGNORE> will
interfere with this method.
Accepted options:
=over 4
=item stdin_data => $input
=item stdin_data => \@input
=item timeout => $timeout
See L</Timeouts>.
=item stdin_fh => $fh
=item stdin_discard => $bool
=item stderr_fh => $fh
=item stderr_discard => $bool
=item stderr_to_stdout => $bool
=item tty => $bool
See the L</open_ex> method documentation for an explanation of these
options.
=back
=item ($output, $errput) = $ssh->capture2(\%opts, @cmd)
captures the output sent to both stdout and stderr by C<@cmd> on the
remote machine.
Setting C<$SIG{CHLD}> to a custom signal handler or to C<IGNORE> will
also interfere with this method.
The accepted options are:
=over 4
=item stdin_data => $input
=item stdin_data => \@input
See the L</system> method documentation for an explanation of these
options.
=item timeout => $timeout
See L</Timeouts>.
=item stdin_fh => $fh
=item stdin_discard => $bool
=item tty => $bool
See the L</open_ex> method documentation for an explanation of these
options.
=back
=item ($in, $pid) = $ssh->pipe_in(\%opts, @cmd)
X<pipe_in>This method is similar to the following Perl C<open> call
$pid = open $in, '|-', @cmd
but running @cmd on the remote machine (see L<perlfunc/open>).
No options are currently accepted.
There is no need to perform a waitpid on the returned PID as it will
be done automatically by perl when C<$in> is closed.
Example:
my ($in, $pid) = $ssh->pipe_in('cat >/tmp/fpp')
or die "pipe_in failed: " . $ssh->error;
print $in $_ for @data;
close $in or die "close failed";
=item ($out, $pid) = $ssh->pipe_out(\%opts, @cmd)
X<pipe_out>Reciprocal to previous method, it is equivalent to
$pid = open $out, '-|', @cmd
running @cmd on the remote machine.
No options are currently accepted.
=item ($in, $out, $pid) = $ssh->open2(\%opts, @cmd)
=item ($pty, $pid) = $ssh->open2pty(\%opts, @cmd)
=item ($socket, $pid) = $ssh->open2socket(\%opts, @cmd)
=item ($in, $out, $err, $pid) = $ssh->open3(\%opts, @cmd)
=item ($pty, $err, $pid) = $ssh->open3pty(\%opts, @cmd)
Shortcuts around L</open_ex> method.
=item $pid = $ssh->spawn(\%opts, @_)
X<spawn>Another L</open_ex> shortcut, it launches a new remote process
in the background and returns the PID of the local slave SSH process.
At some later point in your script, C<waitpid> should be called on the
returned PID in order to reap the slave SSH process.
For instance, you can run some command on several hosts in parallel
with the following code:
my %conn = map { $_ => Net::OpenSSH->new($_, async => 1) } @hosts;
my @pid;
for my $host (@hosts) {
open my($fh), '>', "/tmp/out-$host.txt"
or die "unable to create file: $!";
push @pid, $conn{$host}->spawn({stdout_fh => $fh}, $cmd);
}
waitpid($_, 0) for @pid;
Note that C<spawn> should not be used to start detached remote
processes that may survive the local program (see also the L</FAQ>
about running remote processes detached).
=item ($socket, $pid) = $ssh->open_tunnel(\%opts, $dest_host, $port)
=item ($socket, $pid) = $ssh->open_tunnel(\%opts, $socket_path)
X<open_tunnel>Similar to L</open2socket>, but instead of running a
command, it opens a TCP tunnel to the given address. See also
L</Tunnels>.
=item $out = $ssh->capture_tunnel(\%opts, $dest_host, $port)
=item @out = $ssh->capture_tunnel(\%opts, $dest_host, $port)
X<capture_tunnel>Similar to L</capture>, but instead of running a command, it opens a
TCP tunnel.
Example:
$out = $ssh->capture_tunnel({stdin_data => join("\r\n",
"GET / HTTP/1.0",
"Host: www.perl.org",
"", "") },
'www.perl.org', 80)
See also L</Tunnels>.
=item $ssh->scp_get(\%opts, $remote1, $remote2,..., $local_dir_or_file)
=item $ssh->scp_put(\%opts, $local, $local2,..., $remote_dir_or_file)
These two methods are wrappers around the C<scp> command that allow
transfers of files to/from the remote host using the existing SSH
master connection.
When transferring several files, the target argument must point to an
existing directory. If only one file is to be transferred, the target
argument can be a directory or a file name or can be omitted. For
instance:
$ssh->scp_get({glob => 1}, '/var/tmp/foo*', '/var/tmp/bar*', '/tmp');
$ssh->scp_put('/etc/passwd');
Both L</scp_get> and L</scp_put> methods return a true value when all
the files are transferred correctly, otherwise they return undef.
Accepted options:
=over 4
=item quiet => 0
By default, C<scp> is called with the quiet flag C<-q> enabled in
order to suppress progress information. This option allows one to
re-enable the progress indication bar.
=item verbose => 1
Calls C<scp> with the C<-v> flag.
=item recursive => 1
Copies files and directories recursively.
=item glob => 1
Enables expansion of shell metacharacters in the sources list so that
wildcards can be used to select files.
=item glob_flags => $flags
Second argument passed to L<File::Glob::bsd_glob|File::Glob/bsd_glob>
function. Only available for L</scp_put> method.
=item copy_attrs => 1
Copies modification and access times and modes from the original
files.
=item bwlimit => $Kbits
Limits the used bandwidth, specified in Kbit/s.
=item timeout => $secs
The transfer is aborted if the connection does not finish before the
given timeout elapses. See also L</Timeouts>.
=item async => 1
Does not wait for the C<scp> command to finish. When this option is
used, the method returns the PID of the child C<scp> process.
For instance, it is possible to transfer files to several hosts in
parallel as follows:
use Errno;
my (%pid, %ssh);
for my $host (@hosts) {
$ssh{$host} = Net::OpenSSH->new($host, async => 1);
}
for my $host (@hosts) {
$pid{$host} = $ssh{$host}->scp_put({async => 1}, $local_fn, $remote_fn)
or warn "scp_put to $host failed: " . $ssh{$host}->error . "\n";
}
for my $host (@hosts) {
if (my $pid = $pid{$host}) {
if (waitpid($pid, 0) > 0) {
my $exit = ($? >> 8);
$exit and warn "transfer of file to $host failed ($exit)\n";
}
else {
redo if ($! == EINTR);
warn "waitpid($pid) failed: $!\n";
}
}
}
=item stdout_fh => $fh
=item stderr_fh => $fh
=item stderr_to_stdout => 1
These options are passed unchanged to method L</open_ex>, allowing
capture of the output of the C<scp> program.
Note that C<scp> will not generate progress reports unless its stdout
stream is attached to a tty.
=item ssh_opts => \@opts
List of extra options for the C<ssh> command.
This feature should be used with care, as the given options are not
checked in any way by the module, and they could interfere with it.
=back
=item $ssh->rsync_get(\%opts, $remote1, $remote2,..., $local_dir_or_file)
=item $ssh->rsync_put(\%opts, $local1, $local2,..., $remote_dir_or_file)
These methods use C<rsync> over SSH to transfer files from/to the remote
machine.
They accept the same set of options as the C<scp> ones.
Any unrecognized option will be passed as an argument to the C<rsync>
command (see L<rsync(1)>). Underscores can be used instead of dashes
in C<rsync> option names.
For instance:
$ssh->rsync_get({exclude => '*~',
verbose => 1,
safe_links => 1},
'/remote/dir', '/local/dir');
=item $sftp = $ssh->sftp(%sftp_opts)
X<Net_SFTP_Foreign>Creates a new L<Net::SFTP::Foreign|Net::SFTP::Foreign> object
for SFTP interaction that runs through the ssh master connection.
=item @call = $ssh->make_remote_command(\%opts, @cmd)
=item $call = $ssh->make_remote_command(\%opts, @cmd)
This method returns the arguments required to execute a command on the
remote machine via SSH. For instance:
my @call = $ssh->make_remote_command(ls => "/var/log");
system @call;
In scalar context, returns the arguments quoted and joined into one
string:
my $remote = $ssh->make_remote_comand("cd /tmp/ && tar xf -");
system "tar cf - . | $remote";
The options accepted are as follows:
=over 4
=item tty => $bool
Enables/disables allocation of a tty on the remote side.
=item forward_agent => $bool
Enables/disables forwarding of authentication agent.
This option can only be used when agent forwarding has been previously
requested on the constructor.
=item tunnel => 1
Return a command to create a connection to some TCP server reachable
from the remote host. In that case the arguments are the destination
address and port. For instance:
$cmd = $ssh->make_remote_command({tunnel => 1}, $host, $port);
=back
=item $ssh->wait_for_master($async)
When the connection has been established by calling the constructor
with the C<async> option, this call allows one to advance the process.
If C<$async> is true, it will perform any work that can be done
immediately without waiting (for instance, entering the password or
checking for the existence of the multiplexing socket) and then
return. If a false value is given, it will finalize the connection
process and wait until the multiplexing socket is available.
It returns a true value after the connection has been successfully
established. False is returned if the connection process fails or if
it has not yet completed (then, the L</error> method can be used to
distinguish between both cases).
From version 0.64 upwards, undef is returned when the master is still
in an unstable state (login, killing, etc.) and 0 when it is in a
stable state (running, stopped or gone).
=item $ssh->check_master
This method runs several checks to ensure that the master connection
is still alive.
=item $ssh->shell_quote(@args)
Returns the list of arguments quoted so that they will be restored to
their original form when parsed by the remote shell.
In scalar context returns the list of arguments quoted and joined.
Usually this task is done automatically by the module. See L</"Shell
quoting"> below.
This method can also be used as a class method.
Example:
my $quoted_args = Net::OpenSSH->shell_quote(@args);
system('ssh', '--', $host, $quoted_args);
=item $ssh->shell_quote_glob(@args)
This method is like the previous C<shell_quote> but leaves wildcard
characters unquoted.
It can be used as a class method also.
=item $ssh->set_expand_vars($bool)
Enables/disables variable expansion feature (see L</"Variable
expansion">).
=item $ssh->get_expand_vars
Returns current state of variable expansion feature.
=item $ssh->set_var($name, $value)
=item $ssh->get_var($name, $value)
These methods allow one to change and to retrieve the value of the
given name.
=item $ssh->get_master_pid
Returns the PID of the master SSH process
=item $ssh->master_exited
This methods allows one to tell the module that the master process has
exited when we get its PID from some external wait or waitpid
call. For instance:
my $ssh = Net::OpenSSH->new('foo', async => 1);
# create new processes
# ...
# rip them...
my $master_pid = $ssh->master_pid;
while ((my $pid = wait) > 0) {
if ($pid == $master_pid) {
$ssh->master_exited;
}
}
If your program rips the master process and this method is not called,
the OS could reassign the PID to a new unrelated process and the
module would try to kill it at object destruction time.
=item $ssh->disconnect($async)
Shuts down the SSH connection.
Usually, you don't need to call this method explicitly, but just let
the Net::OpenSSH object go out of scope.
If C<async> is true, it doesn't wait for the SSH connection to
terminate. In that case, L</wait_for_master> must be called repeatedly
until the shutdown sequence terminates (See the L</AnyEvent>
integration section below).
=item $pid = $ssh->sshfs_import(\%opts, $remote_fs, $local_mnt_point)
=item $pid = $ssh->sshfs_export(\%opts, $local_fs, $remote_mnt_point)
These methods use L<sshfs(1)> to import or export a file system
through the SSH connection.
They return the C<$pid> of the C<sshfs> process or of the slave C<ssh>
process used to proxy it. Killing that process unmounts the file
system, though, it may be probably better to use L<fusermount(1)>.
The options accepted are as follows:
=over
=item ssh_opts => \@ssh_opts
Options passed to the slave C<ssh> process.
=item sshfs_opts => \@sshfs_opts
Options passed to the C<sshfs> command. For instance, to mount the file
system in read-only mode:
my $pid = $ssh->sshfs_export({sshfs_opts => [-o => 'ro']},
"/", "/mnt/foo");
=back
Note that this command requires a recent version of C<sshfs> to work (at
the time of writing, it requires the yet unreleased version available
from the FUSE git repository!).
See also the L<sshfs(1)> man page and the C<sshfs> and FUSE web sites
at L<https://github.com/libfuse/sshfs> and
L<https://github.com/libfuse/libfuse> respectively.
=item $or = $ssh->object_remote(@args)
X<Object_Remote>Returns an L<Object::Remote::Connection> instance
running on top of the Net::OpenSSH connection.
Example:
my $or = $ssh->object_remote;
my $hostname = Sys::Hostname->can::on($or, 'hostname');
say $hostname->();
See also L<Object::Remote>.
=item $any = $ssh->any(%opts)
X<Net_SSH_Any>Wraps the current object inside a Net::SSH::Any one.
Example:
my $any = $ssh->any;
my $content = $any->scp_get_content("my-file.txt");
=item $pid = $ssh->disown_master
Under normal operation Net::OpenSSH controls the life-time of the
master C<ssh> process and when the object is destroyed the master
process and any connection running over it are terminated.
In some (rare) cases, it is desirable to let the master process and
all the running connections survive. Calling this method does just
that, it tells Net::OpenSSH object that the master process is not its
own anymore.
The return value is the PID of the master process.
Note also that disowning the master process does not affect the
operation of the module in any other regard.
For instance:
# See sample/sshfs_mount.pl for a working program
my $ssh = Net::OpenSSH->new($host);
my $sshfs_pid = $ssh->sshfs_import("/home/foo", "my-remote-home");
$ssh->disown_master;
$ssh->stop; # tells the master to stop accepting requests
exit(0);
=back
=head2 Shell quoting
By default, when invoking remote commands, this module tries to mimic
perl C<system> builtin in regard to argument processing. Quoting
L<perlfunc/system>:
Argument processing varies depending on the number of arguments. If
there is more than one argument in LIST, or if LIST is an array with
more than one value, starts the program given by the first element
of the list with arguments given by the rest of the list. If there
is only one scalar argument, the argument is checked for shell
metacharacters, and if there are any, the entire argument is passed
to the system's command shell for parsing (this is "/bin/sh -c" on
Unix platforms, but varies on other platforms).
Take for example Net::OpenSSH L</system> method:
$ssh->system("ls -l *");
$ssh->system('ls', '-l', '/');
The first call passes the argument unchanged to ssh and it is executed
in the remote side through the shell which interprets metacharacters.
The second call escapes any shell metacharacters so that, effectively,
it is equivalent to calling the command directly and not through the
shell.
Under the hood, as the Secure Shell protocol does not provide for this
mode of operation and always spawns a new shell where it runs the
given command, Net::OpenSSH quotes any shell metacharacters in the
command list.
All the methods that invoke a remote command (system, open_ex, etc.)
accept the option C<quote_args> that allows one to force/disable shell
quoting.
For instance:
$ssh->system({quote_args => 1}, "/path with spaces/bin/foo");
will correctly handle the spaces in the program path.
The shell quoting mechanism implements some extensions (for instance,
performing redirections to /dev/null on the remote side) that can be
disabled with the option C<quote_args_extended>:
$ssh->system({ stderr_discard => 1,
quote_args => 1, quote_args_extended => 0 },
@cmd);
The option C<quote_args> can also be used to disable quoting when more
than one argument is passed. For instance, to get some pattern
expanded by the remote shell:
$ssh->system({quote_args => 0}, 'ls', '-l', "/tmp/files_*.dat");
The method C<shell_quote> can be used to selectively quote some
arguments and leave others untouched:
$ssh->system({quote_args => 0},
$ssh->shell_quote('ls', '-l'),
"/tmp/files_*.dat");
When the glob option is set in C<scp> and C<rsync> file transfer
methods, an alternative quoting method which knows about file
wildcards and passes them unquoted is used. The set of wildcards
recognized currently is the one supported by L<bash(1)>.
Another way to selectively use quote globing or fully disable quoting
for some specific arguments is to pass them as scalar references or
double scalar references respectively. In practice, that means
prepending them with one or two backslashes. For instance:
# quote the last argument for globing:
$ssh->system('ls', '-l', \'/tmp/my files/filed_*dat');
# append a redirection to the remote command
$ssh->system('ls', '-lR', \\'>/tmp/ls-lR.txt');
# expand remote shell variables and glob in the same command:
$ssh->system('tar', 'czf', \\'$HOME/out.tgz', \'/var/log/server.*.log');
As shell quoting is a tricky matter, I expect bugs to appear in this
area. You can see how C<ssh> is called, and the quoting used setting
the following debug flag:
$Net::OpenSSH::debug |= 16;
By default, the module assumes the remote shell is some variant of a
POSIX or Bourne shell (C<bash>, C<dash>, C<ksh>, etc.). If this is not
the case, the construction option C<remote_shell> can be used to
select an alternative quoting mechanism.
For instance:
$ssh = Net::OpenSSH->new($host, remote_shell => 'csh');
$ssh->system(echo => "hard\n to\n quote\n argument!");
Currently there are quoters available for POSIX (Bourne) compatible
shells, C<csh> and the two Windows variants C<MSWin> (for servers
using L<Win32::CreateProcess>, see
L<Net::OpenSSH::ShellQuoter::MSWin>) and C<MSCmd> (for servers using
C<cmd.exe>, see L<Net::OpenSSH::ShellQuoter::MSCmd>).
In any case, you can always do the quoting yourself and pass the
quoted remote command as a single string:
# for VMS
$ssh->system('DIR/SIZE NFOO::USERS:[JSMITH.DOCS]*.TXT;0');
Note that the current quoting mechanism does not handle possible
aliases defined by the remote shell. In that case, to force execution
of the command instead of the alias, the full path to the command must
be used.
=head2 Timeouts
In order to stop remote processes when they timeout, the ideal approach
would be to send them signals through the SSH connection as specified
by the protocol standard.
Unfortunately OpenSSH does not implement that feature so Net::OpenSSH
has to use other imperfect approaches:
=over 4
=item * close slave I/O streams
Closing the STDIN and STDOUT streams of the unresponsive remote
process will effectively deliver a SIGPIPE when it tries to access any
of them.
Remote processes may not access STDIN or STDOUT and even then,
Net::OpenSSH can only close these channels when it is capturing them,
so this approach does not always work.
=item * killing the local SSH slave process
This action may leave the remote process running, creating a remote
orphan so Net::OpenSSH does not use it unless the construction option
C<kill_ssh_on_timeout> is set.
=back
Luckily, future versions of OpenSSH will support signaling remote
processes via the mux channel.
=head2 Variable expansion
The variable expansion feature allows one to define variables that are
expanded automatically inside command arguments and file paths.
This feature is disabled by default. It is intended to be used with
L<Net::OpenSSH::Parallel|Net::OpenSSH::Parallel> and other similar
modules.
Variables are delimited by a pair of percent signs (C<%>), for
instance C<%HOST%>. Also, two consecutive percent signs are replaced
by a single one.
The special variables C<HOST>, C<USER> and C<PORT> are maintained
internally by the module and take the obvious values.
Variable expansion is performed before shell quoting (see L</"Shell
quoting">).
Some usage example:
my $ssh = Net::OpenSSH->new('server.foo.com', expand_vars => 1);
$ssh->set_var(ID => 42);
$ssh->system("ls >/tmp/ls.out-%HOST%-%ID%");
will redirect the output of the C<ls> command to
C</tmp/ls.out-server.foo.com-42> on the remote host.
=head2 Tunnels
Besides running commands on the remote host, Net::OpenSSH also allows
one to tunnel TCP connections to remote machines reachable from the
SSH server.
That feature is made available through the C<tunnel> option of the
L</open_ex> method, and also through wrapper methods L</open_tunnel>
and L</capture_tunnel> and most others where it makes sense.
Example:
$ssh->system({tunnel => 1,
stdin_data => "GET / HTTP/1.0\r\n\r\n",
stdout_file => "/tmp/$server.res"},
$server, 80)
or die "unable to retrieve page: " . $ssh->error;
or capturing the output of several requests in parallel:
my @pids;
for (@servers) {
my $pid = $ssh->spawn({tunnel => 1,
stdin_file => "/tmp/request.req",
stdout_file => "/tmp/$_.res"},
$_, 80);
if ($pid) {
push @pids, $pid;
}
else {
warn "unable to spawn tunnel process to $_: " . $ssh->error;
}
}
waitpid ($_, 0) for (@pids);
Under the hood, in order to create a tunnel, a new C<ssh> process is
spawned with the option C<-W${address}:${port}> (available from
OpenSSH 5.4 and upwards) making it redirect its stdio streams to the
remote given address. Unlike when C<ssh> C<-L> options is used to
create tunnels, no TCP port is opened on the local machine at any time
so this is a perfectly secure operation.
The PID of the new process is returned by the named methods. It must
be reaped once the pipe or socket handlers for the local side of the
tunnel have been closed.
OpenSSH 5.4 or later is required for the tunnels functionality to
work. Also, note that tunnel forwarding may be administratively
forbidden at the server side (see L<sshd(8)> and L<sshd_config(5)> or
the documentation provided by your SSH server vendor).
When connecting to hosts running a recent version of OpenSSH sshd, it
is also possible to open connections targeting Unix sockets.
For instance:
my $response = $ssh->capture({tunnel => 1, stdin_data => $request },
"/tmp/socket-foo");
Currently, this feature requires a patched OpenSSH ssh client. The
patch is available as
C<patches/openssh-fwd-stdio-to-streamlocal-1.patch>.
=head2 Data encoding
Net::OpenSSH has some support for transparently converting the data send
or received from the remote server to Perl internal unicode
representation.
The methods supporting that feature are those that move data from/to
Perl data structures (e.g. C<capture>, C<capture2>, C<capture_tunnel>
and methods supporting the C<stdin_data> option). Data accessed through
pipes, sockets or redirections is not affected by the encoding options.
It is also possible to set the encoding of the command and arguments
passed to the remote server on the command line.
By default, if no encoding option is given on the constructor or on the
method calls, Net::OpenSSH will not perform any encoding transformation,
effectively processing the data as C<latin1>.
When data can not be converted between the Perl internal
representation and the selected encoding inside some Net::OpenSSH
method, it will fail with an C<OSSH_ENCODING_ERROR> error.
The supported encoding options are as follows:
=over 4
=item stream_encoding => $encoding
sets the encoding of the data send and received on capture methods.
=item argument_encoding => $encoding
sets the encoding of the command line arguments
=item encoding => $encoding
sets both C<argument_encoding> and C<stream_encoding>.
=back
The constructor also accepts C<default_encoding>,
C<default_stream_encoding> and C<default_argument_encoding> that set the
defaults.
=head2 Diverting C<new>
When a code ref is installed at C<$Net::OpenSSH::FACTORY>, calls to new
will be diverted through it.
That feature can be used to transparently implement connection
caching, for instance:
my $old_factory = $Net::OpenSSH::FACTORY;
my %cache;
sub factory {
my ($class, %opts) = @_;
my $signature = join("\0", $class, map { $_ => $opts{$_} }, sort keys %opts);
my $old = $cache{signature};
return $old if ($old and $old->error != OSSH_MASTER_FAILED);
local $Net::OpenSSH::FACTORY = $old_factory;
$cache{$signature} = $class->new(%opts);
}
$Net::OpenSSH::FACTORY = \&factory;
... and I am sure it can be abused in several other ways!
=head1 3rd PARTY MODULE INTEGRATION
=head2 Expect
Sometimes you would like to use L<Expect> to control some program
running in the remote host. You can do it as follows:
my ($pty, $pid) = $ssh->open2pty(@cmd)
or die "unable to run remote command @cmd";
my $expect = Expect->init($pty);
Then, you will be able to use the new Expect object in C<$expect> as
usual.
=head2 Net::Telnet
This example is adapted from L<Net::Telnet> documentation:
my ($pty, $pid) = $ssh->open2pty({stderr_to_stdout => 1})
or die "unable to start remote shell: " . $ssh->error;
my $telnet = Net::Telnet->new(-fhopen => $pty,
-prompt => '/.*\$ $/',
-telnetmode => 0,
-cmd_remove_mode => 1,
-output_record_separator => "\r");
$telnet->waitfor(-match => $telnet->prompt,
-errmode => "return")
or die "login failed: " . $telnet->lastline;
my @lines = $telnet->cmd("who");
...
$telnet->close;
waitpid($pid, 0);
=head2 mod_perl and mod_perl2
L<mod_perl> and L<mod_perl2> tie STDIN and STDOUT to objects that are
not backed up by real file descriptors at the operating system
level. Net::OpenSSH will fail if any of these handles is used
explicitly or implicitly when calling some remote command.
The work-around is to redirect them to C</dev/null> or to some file:
open my $def_in, '<', '/dev/null' or die "unable to open /dev/null";
my $ssh = Net::OpenSSH->new($host,
default_stdin_fh => $def_in);
my $out = $ssh->capture($cmd1);
$ssh->system({stdout_discard => 1}, $cmd2);
$ssh->system({stdout_to_file => '/tmp/output'}, $cmd3);
Also, note that from a security stand point, running C<ssh> from
inside the web server process is not a great idea. An attacker
exploiting some Apache bug would be able to access the SSH keys and
passwords and gain unlimited access to the remote systems.
If you can, use a queue (as L<TheSchwartz|TheSchwartz>) or any other
mechanism to execute the ssh commands from another process running
under a different user account.
At a minimum, ensure that C<~www-data/.ssh> (or similar) is not
accessible through the web server!
=head2 Net::SFTP::Foreign
See L<method C<sftp>|/Net_SFTP_Foreign>.
=head2 Net::SSH::Any
See L<method C<any>|/Net_SSH_Any>.
=head2 Object::Remote
See L<method C<object_remote>|/Object_Remote>.
=head2 AnyEvent (and similar frameworks)
X<AnyEvent>Net::OpenSSH provides all the functionality required to be
integrated inside event oriented programming framework such as
L<AnyEvent> or L<IO::Async> in the following way:
=over 4
=item 1. Create a disconnected Net::OpenSSH object:
my $ssh = Net::OpenSSH->new($host, async => 1, ...);
=item 2. Let the object connect to the remote host:
Use a timer to call the C<wait_for_master> method in async mode
repeatedly until it returns a true value indicating success.
Also, the object error state needs to be checked after every call in
order to detect failed connections. For instance:
my $ssh = Net::OpenSSH->new(..., async => 1);
my $w;
$w = AE::timer 0.1, 0.1, sub {
if ($ssh->wait_for_master(1)) {
# the connection has been established!
# remote commands can be run now
undef $w;
on_ssh_success(...);
}
elsif ($ssh->error) {
# connection can not be established
undef $w;
on_ssh_failure(...);
}
}
=item 3. Use the event framework to launch the remote processes:
Call Net::OpenSSH C<make_remote_command> to construct commands which
can be run using the framework regular facilities for launching external
commands.
Error checking should also be performed at this point because the SSH
connection could be broken.
For instance:
if (defined(my $cmd = $ssh->make_remote_command(echo => 'hello!')) {
AnyEvent::Util::run_cmd($cmd, %run_cmd_opts);
}
else {
# something went wrong!
}
Alternatively, any of the C<open*> methods provided by Net::OpenSSH
could also be used to launch remote commands.
=item 4. When finished, disconnect asynchronously
After initiating an asynchronous disconnect with C<disconnect(1)>,
repeatedly call C<wait_for_master> until you get a defined but false
value:
$ssh->disconnect(1);
my $w; $w = AE::timer 0.1, 0.1, sub {
my $res = $ssh->wait_for_master(1);
if (defined $res && !$res) {
undef $w;
undef $ssh;
}
};
Be careful not to let the C<$ssh> object go out of scope until the
disconnection has finished, otherwise its destructor will wait and
block your program until the disconnection has completed.
=back
=head2 Other modules
CPAN contains several modules that rely on SSH to perform their duties
as for example L<IPC::PerlSSH|IPC::PerlSSH> or
L<GRID::Machine|GRID::Machine>.
Often, it is possible to instruct them to go through a Net::OpenSSH
multiplexed connection employing some available constructor
option. For instance:
use Net::OpenSSH;
use IPC::PerlIPC;
my $ssh = Net::OpenSSH->new(...);
$ssh->error and die "unable to connect to remote host: " . $ssh->error;
my @cmd = $ssh->make_remote_command('/usr/bin/perl');
my $ipc = IPC::PerlSSH->new(Command => \@cmd);
my @r = $ipc->eval('...');
or...
use GRID::Machine;
...
my @cmd = $ssh->make_remote_command('/usr/bin/perl');
my $grid = GRID::Machine->new(command => \@cmd);
my $r = $grid->eval('print "hello world!\n"');
In other cases, some kind of plugin mechanism is provided by the 3rd
party modules to allow for different transports. The method C<open2>
may be used to create a pair of pipes for transport in these cases.
=head1 TROUBLESHOOTING
Usually, Net::OpenSSH works out of the box, but when it fails, some
users have a hard time finding the cause of the problem. This mini
troubleshooting guide should help you to find and solve it.
=over 4
=item 1 - check the error message
Add in your script, after the Net::OpenSSH constructor call, an error
check:
$ssh = Net::OpenSSH->new(...);
$ssh->error and die "SSH connection failed: " . $ssh->error;
The error message will tell what has gone wrong.
=item 2 - OpenSSH version
Ensure that you have a version of C<ssh> recent enough:
$ ssh -V
OpenSSH_5.1p1 Debian-5, OpenSSL 0.9.8g 19 Oct 2007
OpenSSH version 4.1 was the first to support the multiplexing feature
and is the minimal required by the module to work. I advise you to use
the latest OpenSSH (currently 5.8) or at least a more recent
version.
The C<ssh_cmd> constructor option lets you select the C<ssh> binary to
use. For instance:
$ssh = Net::OpenSSH->new($host,
ssh_cmd => "/opt/OpenSSH/5.8/bin/ssh")
Some hardware vendors (e.g. Sun, err... Oracle) include custom
versions of OpenSSH bundled with the operating system. In principle,
Net::OpenSSH should work with these SSH clients as long as they are
derived from some version of OpenSSH recent enough. Anyway, my advise
is to use the real OpenSSH software if you can!
=item 3 - run ssh from the command line
Check you can connect to the remote host using the same parameters you
are passing to Net::OpenSSH. In particular, ensure that you are
running C<ssh> as the same local user.
If you are running your script from a web server, the user
would probably be C<www>, C<apache> or something alike.
Common problems are:
=over 4
=item *
Remote host public key not present in known_hosts file.
The SSH protocol uses public keys to identify the remote hosts so that
they can not be supplanted by some malicious third parties.
For OpenSSH, usually the server public key is stored in
C</etc/ssh/ssh_host_dsa_key.pub> or in
C</etc/ssh/ssh_host_rsa_key.pub> and that key should be copied into the
C<~/.ssh/known_hosts> file in the local machine (other SSH
implementations may use other file locations).
Maintaining the server keys when several hosts and clients are
involved may be somewhat inconvenient, so most SSH clients, by
default, when a new connection is established to a host whose key is
not in the C<known_hosts> file, show the key and ask the user if he
wants the key copied there.
=item *
Wrong remote host public key in known_hosts file.
This is another common problem that happens when some server is
replaced or reinstalled from scratch and its public key changes
becoming different to that installed on the C<known_hosts> file.
The easiest way to solve that problem is to remove the old key from
the C<known_hosts> file by hand using any editor and then to connect
to the server replying C<yes> when asked to save the new key.
=item *
Wrong permissions for the C<~/.ssh> directory or its contents.
OpenSSH client performs several checks on the access permissions of
the C<~/.ssh> directory and its contents and refuses to use them when
misconfigured. See the FILES section from the L<ssh(1)> man page.
=item *
Incorrect settings for password or public key authentication.
Check that you are using the right password or that the user public
key is correctly installed on the server.
=back
=item 4 - security checks on the multiplexing socket
Net::OpenSSH performs some security checks on the directory where the
multiplexing socket is going to be placed to ensure that it can not be
accessed by other users.
The default location for the multiplexing socket is under
C<~/.libnet-openssh-perl>. It can be changed using the C<ctl_dir> and
C<ctl_path> constructor arguments.
The requirements for that directory and all its parents are:
=over 4
=item *
They have to be owned by the user executing the script or by root
=item *
Their permission masks must be 0755 or more restrictive, so nobody
else has permissions to perform write operations on them.
=back
The constructor option C<strict_mode> disables these security checks,
but you should not use it unless you understand its implications.
=item 5 - file system must support sockets
Some file systems (as for instance FAT or AFS) do not support placing
sockets inside them.
Ensure that the C<ctl_dir> path does not lay into one of those file
systems.
=back
=head1 DEBUGGING
Debugging of Net::OpenSSH internals is controlled through the variable
C<$Net::OpenSSH::debug>. Every bit of this variable activates
debugging of some subsystem as follows:
=over 4
=item bit 1 - errors
Dumps changes on the internal object attribute where errors are stored.
=item bit 2 - ctl_path
Dumps information about ctl_path calculation and the tests performed
on that directory in order to decide if it is secure to place the
multiplexing socket inside.
=item bit 4 - connecting
Dumps information about the establishment of new master connections.
=item bit 8 - commands and arguments
Dumps the command and arguments for every system/exec call.
=item bit 16 - command execution
Dumps information about the progress of command execution.
=item bit 32 - destruction
Dumps information about the destruction of Net::OpenSSH objects and
the termination of the SSH master processes.
=item bit 64 - IO loop
Dumps information about the progress of the IO loop on capture
operations.
=item bit 128 - IO hexdumps
Generates hexdumps of the information that travels through the SSH
streams inside capture operations.
=item bit 512 - OS tracing of the master process
Use the module L<Net::OpenSSH::OSTracer> to trace the SSH master
process at the OS level.
=back
For instance, in order to activate all the debugging flags, you can
use:
$Net::OpenSSH::debug = ~0;
Note that the meaning of the flags and the information generated is
only intended for debugging of the module and may change without
notice between releases.
If you are using password authentication, enabling debugging for
L<IO::Tty> may also show interesting information:
IO::Tty::DEBUG = 1;
Finally, by default debugging output is sent to C<STDERR>. You can
override it pointing C<$Net::OpenSSH::debug_fh> to a different file
handle. For instance:
BEGIN {
open my $out, '>', '/tmp/debug.txt' or warn $!;
$Net::OpenSSH::debug_fh = $out;
$Net::OpenSSH::debug = -1;
}
=head1 SECURITY
B<Q>: Is this module secure?
B<A>: Well, it tries to be!
From a security standpoint the aim of this module is to be as secure
as OpenSSH, your operating system, your shell and in general your
environment allow it to be.
It does not take any shortcut just to make your life easier if that
means lowering the security level (for instance, disabling
C<StrictHostKeyChecking> by default).
In code supporting features that are not just proxied to OpenSSH,
the module tries to keep the same standards of security as OpenSSH
(for instance, checking directory and file permissions when placing
the multiplexing socket).
On the other hand, and keeping with OpenSSH philosophy, the module
lets you disable most (all?) of those security measures. But just
because it lets you do it it doesn't mean it is a good idea to do
so!!!
If you are a novice programmer or SSH user, and googling you have just
found some flag that you don't understand but that seems to magically
solve your connection problems... well, believe me, it is probably a
bad idea to use it. Ask somebody how really knows first!
Just to make thinks clear, if your code contains any of the keywords
from the (non-exclusive) list below and you don't know why, you are
probably wrecking the security of the SSH protocol:
strict_mode
StrictHostKeyChecking
UserKnownHostsFile
Other considerations related to security you may like to know are as
follows:
=over 4
=item Taint mode
The module supports working in taint mode.
If you are in an exposed environment, you should probably enable it
for your script in order to catch any unchecked command for being
executed in the remote side.
=item Web environments
It is a bad idea to establish SSH connections from your webserver
because if it becomes compromised in any way, the attacker would be
able to use the credentials from your script to connect to the remote
host and do anything he wishes there.
=item Command quoting
The module can quote commands and arguments for you in a flexible
and powerful way.
This is a feature you should use as it reduces the possibility of some
attacker being able to inject and run arbitrary commands on the remote
machine (and even for scripts that are not exposed it is always
advisable to enable argument quoting).
Having said that, take into consideration that argument-quoting is
just a hack to emulate the invoke-without-a-shell feature of Perl
builtins such as C<system> and alike. There may be bugs(*) on the
quoting code, your particular shell may have different quoting rules
with unhandled corner cases or whatever. If your script is exposed to
the outside, you should check your inputs and restrict what you accept
as valid.
[* even if this is one of the parts of the module more intensively
tested!]
=item Shellshock
(see L<Shellshock|http://en.wikipedia.org/wiki/Shellshock_%28software_bug%29>)
When executing local commands, the module always avoids calling the
shell so in this way it is not affected by Shellshock.
Unfortunately, some commands (C<scp>, C<rsync> and C<ssh> when the
C<ProxyCommand> option is used) invoke other commands under the hood
using the user shell. That opens the door to local Shellshock
exploitation.
On the remote side invocation of the shell is unavoidable due to the
protocol design.
By default, SSH does not forward environment variables but some Linux
distributions explicitly change the default OpenSSH configuration to
enable forwarding and acceptance of some specific ones (for instance
C<LANG> and C<LC_*> on Debian and derivatives, Fedora does alike) and
this also opens the door to Shellshock exploitation.
Note that the shell used to invoke commands is not C</bin/sh> but the
user shell as configured in C</etc/passwd>, PAM or whatever
authentication subsystem is used by the local or remote operating
system. Debian users, don't think you are not affected because
your C</bin/sh> points to C<dash>!
=back
=head1 FAQ
Frequent questions about the module:
=over
=item Connecting to switches, routers, etc.
B<Q>: I can not get the method C<system>, C<capture>, etc., to work
when connecting to some router, switch, etc. What I am doing wrong?
B<A>: Roughly, the SSH protocol allows for two modes of operation:
command mode and interactive mode.
Command mode is designed to run single commands on the remote host. It
opens a SSH channel between both hosts, asks the remote computer to
run some given command and when it finishes, the channel is closed. It
is what you get, for instance, when you run something as...
$ ssh my.unix.box cat foo.txt
... and it is also the way Net::OpenSSH runs commands on the remote
host.
Interactive mode launches a shell on the remote hosts with its stdio
streams redirected to the local ones so that the user can
transparently interact with it.
Some devices (as probably the one you are using) do not run an
standard, general purpose shell (e.g. C<bash>, C<csh> or C<ksh>) but
some custom program specially targeted and limited to the task of
configuring the device.
Usually, the SSH server running on these devices does not support
command mode. It unconditionally attaches the restricted shell to any
incoming SSH connection and waits for the user to enter commands
through the redirected stdin stream.
The only way to work-around this limitation is to make your script
talk to the restricted shell (1-open a new SSH session, 2-wait for the
shell prompt, 3-send a command, 4-read the output until you get to the
shell prompt again, repeat from 3). The best tool for this task is
probably L<Expect>, used alone or combined with Net::OpenSSH (see
L</Expect>).
There are some devices that support command mode but that only accept
one command per connection. In that cases, using L<Expect> is also
probably the best option.
Nowadays, there is a new player, L<Net::CLI::Interaction> that may be
more suitable than Expect.
=item Connection fails
B<Q>: I am unable to make the module connect to the remote host...
B<A>: Have you read the troubleshooting section? (see
L</TROUBLESHOOTING>).
=item Disable StrictHostKeyChecking
B<Q>: Why is C<ssh> not run with C<StrictHostKeyChecking=no>?
B<A>: Using C<StrictHostKeyChecking=no> relaxes the default security
level of SSH and it will be relatively easy to end with a
misconfigured SSH (for instance, when C<known_hosts> is unwritable)
that could be forged to connect to a bad host in order to perform
man-in-the-middle attacks, etc.
I advice you to do not use that option unless you fully understand its
implications from a security point of view.
If you want to use it anyway, past it to the constructor:
$ssh = Net::OpenSSH->new($host,
master_opts => [-o => "StrictHostKeyChecking=no"],
...);
=item child process STDIN/STDOUT/STDERR is not a real system file
handle
B<Q>: Calls to C<system>, C<capture>, etc. fail with the previous
error, what's happening?
B<A>: The reported stdio stream is closed or is not attached to a real
file handle (e.g. it is a tied handle). Redirect it to C</dev/null> or
to a real file:
my $out = $ssh->capture({stdin_discard => 1, stderr_to_stdout => 1},
$cmd);
See also the L<mod_perl> entry above.
=item Solaris (and AIX and probably others)
B<Q>: I was trying Net::OpenSSH on Solaris and seem to be running into
an issue...
B<A>: The SSH client bundled with Solaris is an early fork of OpenSSH
that does not provide the multiplexing functionality required by
Net::OpenSSH. You will have to install the OpenSSH client.
Precompiled packages are available from Sun Freeware
(L<http://www.sunfreeware.com>). There, select your OS version an CPU
architecture, download the OpenSSH package and its dependencies and
install them. Note that you do B<not> need to configure Solaris to use
the OpenSSH server C<sshd>.
Ensure that OpenSSH client is in your path before the system C<ssh> or
alternatively, you can hardcode the full path into your scripts
as follows:
$ssh = Net::OpenSSH->new($host,
ssh_cmd => '/usr/local/bin/ssh');
AIX and probably some other unixen, also bundle SSH clients lacking
the multiplexing functionality and require installation of the real
OpenSSH.
=item Can not change working directory
B<Q>: I want to run some command inside a given remote directory but I
am unable to change the working directory. For instance:
$ssh->system('cd /home/foo/bin');
$ssh->systen('ls');
does not list the contents of C</home/foo/bin>.
What am I doing wrong?
B<A>: Net::OpenSSH (and, for that matter, all the SSH modules
available from CPAN but L<Net::SSH::Expect>) run every command in a
new session so most shell builtins that are run for its side effects
become useless (e.g. C<cd>, C<export>, C<ulimit>, C<umask>, etc.,
usually, you can list them running C<help> from the shell).
A work around is to combine several commands in one, for instance:
$ssh->system('cd /home/foo/bin && ls');
Note the use of the shell C<&&> operator instead of C<;> in order to
abort the command as soon as any of the subcommands fail.
Also, several commands can be combined into one while still using the
multi-argument quoting feature as follows:
$ssh->system(@cmd1, \\'&&', @cmd2, \\'&&', @cmd3, ...);
=item Running detached remote processes
B<Q>: I need to be able to ssh into several machines from my script,
launch a process to run in the background there, and then return
immediately while the remote programs keep running...
B<A>: If the remote systems run some Unix/Linux variant, the right
approach is to use L<nohup(1)> that will disconnect the remote process
from the stdio streams and to ask the shell to run the command on the
background. For instance:
$ssh->system("nohup $long_running_command &");
Also, it may be possible to demonize the remote program. If it is
written in Perl you can use L<App::Daemon> for that (actually, there
are several CPAN modules that provided that kind of functionality).
In any case, note that you should not use L</spawn> for that.
=item MaxSessions server limit reached
B<Q>: I created an C<$ssh> object and then fork a lot children
processes which use this object. When the children number is bigger
than C<MaxSessions> as defined in sshd configuration (defaults to 10),
trying to fork new remote commands will prompt the user for the
password.
B<A>: When the slave SSH client gets a response from the remote
servers saying that the maximum number of sessions for the current
connection has been reached, it fall backs to open a new direct
connection without going through the multiplexing socket.
To stop that for happening, the following hack can be used:
$ssh = Net::OpenSSH->new(host,
default_ssh_opts => ['-oConnectionAttempts=0'],
...);
=item Running remote commands with sudo
B<Q>: How can I run remote commands using C<sudo> to become root first?
B<A>: The simplest way is to tell C<sudo> to read the password from
stdin with the C<-S> flag and to do not use cached credentials
with the C<-k> flag. You may also like to use the C<-p> flag to tell
C<sudo> to print an empty prompt. For instance:
my @out = $ssh->capture({ stdin_data => "$sudo_passwd\n" },
'sudo', '-Sk',
'-p', '',
'--',
@cmd);
If the version of sudo installed on the remote host does not support
the C<-S> flag (it tells sudo to read the password from its STDIN
stream), you can do it as follows:
my @out = $ssh->capture({ tty => 1,
stdin_data => "$sudo_passwd\n" },
'sudo', '-k',
'-p', '',
'--',
@cmd);
This may generate an spurious and harmless warning from the SSH master
connection (because we are requesting allocation of a tty on the
remote side and locally we are attaching it to a regular pair of
pipes).
If for whatever reason the methods described above fail, you can
always revert to using Expect to talk to the remote C<sudo>. See the
C<sample/expect.pl> script from this module distribution.
=back
=head1 SEE ALSO
OpenSSH client documentation L<ssh(1)>, L<ssh_config(5)>, the project
web L<http://www.openssh.org> and its FAQ
L<http://www.openbsd.org/openssh/faq.html>. L<scp(1)> and
L<rsync(1)>. The OpenSSH Wikibook
L<http://en.wikibooks.org/wiki/OpenSSH>.
L<Net::OpenSSH::Gateway> for detailed instruction about how to get
this module to connect to hosts through proxies and other SSH gateway
servers.
Core perl documentation L<perlipc>, L<perlfunc/open>,
L<perlfunc/waitpid>.
L<IO::Pty|IO::Pty> to known how to use the pseudo tty objects returned
by several methods on this package.
L<Net::SFTP::Foreign|Net::SFTP::Foreign> provides a compatible SFTP
implementation.
L<Expect|Expect> can be used to interact with commands run through
this module on the remote machine (see also the C<expect.pl> and
<autosudo.pl> scripts in the sample directory).
L<SSH::OpenSSH::Parallel> is an advanced scheduler that allows one to run
commands in remote hosts in parallel. It is obviously based on
Net::OpenSSH.
L<SSH::Batch|SSH::Batch> allows one to run remote commands in parallel in
a cluster. It is build on top on C<Net::OpenSSH> also.
Other Perl SSH clients: L<Net::SSH::Perl|Net::SSH::Perl>,
L<Net::SSH2|Net::SSH2>, L<Net::SSH|Net::SSH>,
L<Net::SSH::Expect|Net::SSH::Expect>, L<Net::SCP|Net::SCP>,
L<Net::SSH::Mechanize|Net::SSH::Mechanize>.
L<Net::OpenSSH::Compat> is a package offering a set of compatibility
layers for other SSH modules on top of Net::OpenSSH.
L<IPC::PerlSSH|IPC::PerlSSH>, L<GRID::Machine|GRID::Machine> allow
execution of Perl code in remote machines through SSH.
L<SSH::RPC|SSH::RPC> implements an RPC mechanism on top of SSH using
Net::OpenSSH to handle the connections.
L<Net::CLI::Interact> allows one to interact with remote shells
and other services. It is specially suited for interaction with
network equipment. The passphrase approach it uses is very clever. You
may also like to check the L<other
modules|https://metacpan.org/author/OLIVER> from its author, Oliver
Gorwits.
=head1 BUGS AND SUPPORT
=head2 Experimental features
L<Object::Remote> integration is highly experimental.
Support for tunnels targeting Unix sockets is highly experimental.
Support for the setpgrp feature is highly experimental.
Support for the gateway feature is highly experimental and mostly
stalled.
Support for taint mode is experimental.
=head2 Known issues
Net::OpenSSH does not work on Windows. OpenSSH multiplexing feature
requires passing file handles through sockets, something that is not
supported by any version of Windows.
It does not work on VMS either... well, probably, it does not work on
anything not resembling a modern Linux/Unix OS.
Old versions of OpenSSH C<ssh> may leave stdio streams in non-blocking
mode. That can result on failures when writing to C<STDOUT> or
C<STDERR> after using the module. In order to work-around this issue,
Perl L<perlfunc/fcntl> can be used to unset the non-blocking flag:
use Fcntl qw(F_GETFL F_SETFL O_NONBLOCK);
my $flags = fcntl(STDOUT, F_GETFL, 0);
fcntl(STDOUT, F_SETFL, $flags & ~O_NONBLOCK);
=head2 Reporting bugs and asking for help
To report bugs send an email to the address that appear below or use
the CPAN bug tracking system at L<http://rt.cpan.org>.
B<Post questions related to how to use the module in PerlMonks>
L<http://perlmonks.org/>, you will probably get faster responses than
if you address me directly and I visit PerlMonks quite often, so I
will see your question anyway.
=head2 Commercial support
Commercial support, professional services and custom software
development around this module are available through my current
company. Drop me an email with a rough description of your
requirements and we will get back to you ASAP.
=head2 My wishlist
If you like this module and you are feeling generous, take a look at
my Amazon Wish List: L<http://amzn.com/w/1WU1P6IR5QZ42>.
Also consider contributing to the OpenSSH project this module builds
upon: L<http://www.openssh.org/donations.html>.
=head1 TODO
- Tests for C<scp_*>, C<rsync_*> and C<sftp> methods
- Make L</pipe_in> and L</pipe_out> methods L</open_ex> based
- C<auto_discard_streams> feature for mod_perl2 and similar environments
- Refactor open_ex support for multiple commands, maybe just keeping
tunnel, ssh and raw
Send your feature requests, ideas or any feedback, please!
=head1 CONTRIBUTING CODE
The source code of this module is hosted at GitHub:
L<http://github.com/salva/p5-Net-OpenSSH>.
Code contributions to the module are welcome but you should obey the
following rules:
=over 4
=item Only Perl 5.8.4 required
Yes, that's pretty old, but Net::OpenSSH is intended to be also used
by system administrators that sometimes have to struggle with old
systems. The reason to pick 5.8.4 is that it has been the default perl
on Solaris for a long time.
=item Avoid the "All the world's a Linux PC" syndrome
The module should work on any (barely) sane Unix or Linux operating
system. Specially, it should not be assumed that the over-featured GNU
utilities and toolchain are available.
=item Dependencies are optional
In order to make the module very easy to install, no mandatory
dependencies on other CPAN modules are allowed.
Optional modules, that are loaded only on demand, are acceptable when
they are used for adding new functionality (as it is done, for
instance, with L<IO::Pty>).
Glue code for integration with 3rd party modules is also allowed (as
it is done with L<Expect>).
Usage of language extension modules and alike is not acceptable.
=item Tests should be lax
We don't want false negatives when testing. In case of doubt tests
should succeed.
Also, in case of tests invoking some external program, it should be
checked that the external program is available and that it works as
expected or otherwise skip those tests.
=item Backward compatibility
Nowadays Net::OpenSSH is quite stable and there are lots of scripts
out there using it that we don't want to break, so, keeping the API
backward compatible is a top priority.
Probably only security issues could now justify a backward
incompatible change.
=item Follow my coding style
Look at the rest of the code.
I let Emacs do the formatting for me using cperl-mode PerlStyle.
=item Talk to me
Before making a large change or implementing a new feature get in
touch with me.
I may have my own ideas about how things should be done. It is better
if you know them before hand, otherwise, you risk getting your patch
rejected.
=back
Well, actually you should know that I am quite good at rejecting
patches but it is not my fault!
Most of the patches I get are broken in some way: they don't follow
the main module principles, sometimes the author didn't get the full
picture and solved the issue in a short-sighted way, etc.
In any case, you should not be discouraged to contribute. Even if your
patch is not applied directly, seeing how it solves your requirements
or, in the case of bugs, the underlying problem analysis may be very
useful and help me to do it... my way.
I always welcome documentation corrections and improvements.
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2008-2017 by Salvador FandiE<ntilde>o
(sfandino@yahoo.com)
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.10.0 or,
at your option, any later version of Perl 5 you may have available.
=cut
|