/usr/share/perl5/Net/SFTP/Foreign.pm is in libnet-sftp-foreign-perl 1.69+dfsg-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 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 | package Net::SFTP::Foreign;
our $VERSION = '1.69';
use strict;
use warnings;
use warnings::register;
use Carp qw(carp croak);
use Symbol ();
use Errno ();
use Fcntl;
BEGIN {
if ($] >= 5.008) {
require Encode;
}
else {
# Work around for incomplete Unicode handling in perl 5.6.x
require bytes;
bytes->import();
*Encode::encode = sub { $_[1] };
*Encode::decode = sub { $_[1] };
*utf8::downgrade = sub { 1 };
}
}
# we make $Net::SFTP::Foreign::Helpers::debug an alias for
# $Net::SFTP::Foreign::debug so that the user can set it without
# knowing anything about the Helpers package!
our $debug;
BEGIN { *Net::SFTP::Foreign::Helpers::debug = \$debug };
use Net::SFTP::Foreign::Helpers qw(_is_reg _is_lnk _is_dir _debug
_sort_entries _gen_wanted
_gen_converter _hexdump
_ensure_list _catch_tainted_args
_file_part);
use Net::SFTP::Foreign::Constants qw( :fxp :flags :att
:status :error
SSH2_FILEXFER_VERSION );
use Net::SFTP::Foreign::Attributes;
use Net::SFTP::Foreign::Buffer;
require Net::SFTP::Foreign::Common;
our @ISA = qw(Net::SFTP::Foreign::Common);
our $dirty_cleanup;
my $windows;
BEGIN {
$windows = $^O =~ /Win(?:32|64)/;
if ($^O =~ /solaris/i) {
$dirty_cleanup = 1 unless defined $dirty_cleanup;
}
}
sub _next_msg_id { shift->{_msg_id}++ }
use constant _empty_attributes => Net::SFTP::Foreign::Attributes->new;
sub _queue_new_msg {
my $sftp = shift;
my $code = shift;
my $id = $sftp->_next_msg_id;
my $msg = Net::SFTP::Foreign::Buffer->new(int8 => $code, int32 => $id, @_);
$sftp->_queue_msg($msg);
return $id;
}
sub _queue_msg {
my ($sftp, $buf) = @_;
my $bytes = $buf->bytes;
my $len = length $bytes;
if ($debug and $debug & 1) {
$sftp->{_queued}++;
_debug(sprintf("queueing msg len: %i, code:%i, id:%i ... [$sftp->{_queued}]",
$len, unpack(CN => $bytes)));
$debug & 16 and _hexdump(pack('N', length($bytes)) . $bytes);
}
$sftp->{_bout} .= pack('N', length($bytes));
$sftp->{_bout} .= $bytes;
}
sub _do_io { $_[0]->{_backend}->_do_io(@_) }
sub _conn_lost {
my ($sftp, $status, $err, @str) = @_;
$debug and $debug & 32 and _debug("_conn_lost");
$sftp->{_status} or
$sftp->_set_status(defined $status ? $status : SSH2_FX_CONNECTION_LOST);
$sftp->{_error} or
$sftp->_set_error((defined $err ? $err : SFTP_ERR_CONNECTION_BROKEN),
(@str ? @str : "Connection to remote server is broken"));
undef $sftp->{_connected};
}
sub _conn_failed {
my $sftp = shift;
$sftp->_conn_lost(SSH2_FX_NO_CONNECTION,
SFTP_ERR_CONNECTION_BROKEN,
@_)
unless $sftp->error;
}
sub _get_msg {
my $sftp = shift;
$debug and $debug & 1 and _debug("waiting for message... [$sftp->{_queued}]");
unless ($sftp->_do_io($sftp->{_timeout})) {
$sftp->_conn_lost(undef, undef, "Connection to remote server stalled");
return undef;
}
my $bin = \$sftp->{_bin};
my $len = unpack N => substr($$bin, 0, 4, '');
my $msg = Net::SFTP::Foreign::Buffer->make(substr($$bin, 0, $len, ''));
if ($debug and $debug & 1) {
$sftp->{_queued}--;
my ($code, $id, $status) = unpack( CNN => $$msg);
$id = '-' if $code == SSH2_FXP_VERSION;
$status = '-' unless $code == SSH2_FXP_STATUS;
_debug(sprintf("got it!, len:%i, code:%i, id:%s, status: %s",
$len, $code, $id, $status));
$debug & 8 and _hexdump($$msg);
}
return $msg;
}
sub _croak_bad_options {
if (@_) {
my $s = (@_ > 1 ? 's' : '');
croak "Invalid option$s '" . CORE::join("', '", @_) . "' or bad combination of options";
}
}
sub _fs_encode {
my ($sftp, $path) = @_;
Encode::encode($sftp->{_fs_encoding}, $path);
}
sub _fs_decode {
my ($sftp, $path) = @_;
Encode::decode($sftp->{_fs_encoding}, $path);
}
sub new {
${^TAINT} and &_catch_tainted_args;
my $class = shift;
unshift @_, 'host' if @_ & 1;
my %opts = @_;
my $sftp = { _msg_id => 0,
_bout => '',
_bin => '',
_connected => 1,
_queued => 0 };
bless $sftp, $class;
$sftp->_clear_error_and_status;
my $backend = delete $opts{backend};
unless (ref $backend) {
$backend = ($windows ? 'Windows' : 'Unix')
unless (defined $backend);
$backend =~ /^\w+$/
or croak "Bad backend name $backend";
my $backend_class = "Net::SFTP::Foreign::Backend::$backend";
eval "require $backend_class; 1"
or croak "Unable to load backend $backend: $@";
$backend = $backend_class->_new($sftp, \%opts);
}
$sftp->{_backend} = $backend;
my %defs = $backend->_defaults;
$sftp->{_autodie} = delete $opts{autodie};
$sftp->{_block_size} = delete $opts{block_size} || $defs{block_size} || 32*1024;
$sftp->{_queue_size} = delete $opts{queue_size} || $defs{queue_size} || 32;
$sftp->{_read_ahead} = $defs{read_ahead} || $sftp->{_block_size} * 4;
$sftp->{_write_delay} = $defs{write_delay} || $sftp->{_block_size} * 8;
$sftp->{_autoflush} = delete $opts{autoflush};
$sftp->{_late_set_perm} = delete $opts{late_set_perm};
$sftp->{_dirty_cleanup} = delete $opts{dirty_cleanup};
$sftp->{_timeout} = delete $opts{timeout};
defined $sftp->{_timeout} and $sftp->{_timeout} <= 0 and croak "invalid timeout";
$sftp->{_fs_encoding} = delete $opts{fs_encoding};
if (defined $sftp->{_fs_encoding}) {
$] < 5.008
and carp "fs_encoding feature is not supported in this perl version $]";
}
else {
$sftp->{_fs_encoding} = 'utf8';
}
$sftp->autodisconnect(delete $opts{autodisconnect});
$backend->_init_transport($sftp, \%opts);
%opts and _croak_bad_options(keys %opts);
$sftp->_init unless $sftp->error;
$backend->_after_init($sftp);
$sftp
}
sub autodisconnect {
my ($sftp, $ad) = @_;
if (defined $ad and $ad != 1) {
if ($ad == 0) {
$sftp->{_disconnect_by_pid} = -1;
}
elsif ($ad == 2) {
$sftp->{_disconnect_by_pid} = $$;
}
else {
croak "bad value '$ad' for autodisconnect";
}
}
1;
}
sub disconnect {
my $sftp = shift;
my $pid = $sftp->{pid};
$debug and $debug & 4 and _debug("$sftp->disconnect called (ssh pid: ".($pid||'').")");
$sftp->_conn_lost;
if (defined $pid) {
close $sftp->{ssh_out} if (defined $sftp->{ssh_out} and not $sftp->{_ssh_out_is_not_dupped});
close $sftp->{ssh_in} if defined $sftp->{ssh_in};
if ($windows) {
kill KILL => $pid
and waitpid($pid, 0);
}
else {
my $dirty = ( defined $sftp->{_dirty_cleanup}
? $sftp->{_dirty_cleanup}
: $dirty_cleanup );
if ($dirty or not defined $dirty) {
for my $sig (($dirty ? () : 0), qw(TERM TERM KILL KILL)) {
$sig and kill $sig, $pid;
my $except;
{
local ($@, $SIG{__DIE__}, $SIG{__WARN__});
eval {
local $SIG{ALRM} = sub { die "timeout\n" };
alarm 8;
waitpid($pid, 0);
alarm 0;
};
$except = $@;
}
if ($except) {
next if $except =~ /^timeout/;
die $except;
}
last;
}
}
else {
while (1) {
last if waitpid($pid, 0) > 0;
if ($! != Errno::EINTR) {
warn "internal error: unexpected error in waitpid($pid): $!"
if $! != Errno::ECHILD;
last;
}
}
}
}
}
1
}
sub DESTROY {
local ($?, $!, $@);
my $sftp = shift;
my $dbpid = $sftp->{_disconnect_by_pid};
$debug and $debug & 4 and _debug("$sftp->DESTROY called (current pid: $$, disconnect_by_pid: ".($dbpid||'').")");
$sftp->disconnect if (!defined $dbpid or $dbpid == $$);
}
sub _init {
my $sftp = shift;
$sftp->_queue_msg( Net::SFTP::Foreign::Buffer->new(int8 => SSH2_FXP_INIT,
int32 => SSH2_FILEXFER_VERSION));
if (my $msg = $sftp->_get_msg) {
my $type = $msg->get_int8;
if ($type == SSH2_FXP_VERSION) {
my $version = $msg->get_int32;
$sftp->{server_version} = $version;
$sftp->{server_extensions} = {};
while (length $$msg) {
my $key = $msg->get_str;
my $value = $msg->get_str;
$sftp->{server_extensions}{$key} = $value;
}
return $version;
}
$sftp->_conn_lost(SSH2_FX_BAD_MESSAGE,
SFTP_ERR_REMOTE_BAD_MESSAGE,
"bad packet type, expecting SSH2_FXP_VERSION, got $type");
}
elsif ($sftp->status == SSH2_FX_CONNECTION_LOST
and $sftp->{_password_authentication}
and $sftp->{_password_sent}) {
$sftp->_set_error(SFTP_ERR_PASSWORD_AUTHENTICATION_FAILED,
"Password authentication failed or connection lost");
}
return undef;
}
sub server_extensions { %{shift->{server_extensions}} }
sub _check_extension {
my ($sftp, $name, $version, $error, $errstr) = @_;
my $ext = $sftp->{server_extensions}{$name};
return 1 if (defined $ext and $ext == $version);
$sftp->_set_status(SSH2_FX_OP_UNSUPPORTED);
$sftp->_set_error($error, "$errstr: extended operation not supported by server");
return undef;
}
# helper methods:
sub _get_msg_and_check {
my ($sftp, $etype, $eid, $err, $errstr) = @_;
my $msg = $sftp->_get_msg;
if ($msg) {
my $type = $msg->get_int8;
my $id = $msg->get_int32;
$sftp->_clear_error_and_status;
if ($id != $eid) {
$sftp->_conn_lost(SSH2_FX_BAD_MESSAGE,
SFTP_ERR_REMOTE_BAD_MESSAGE,
$errstr, "bad packet sequence, expected $eid, got $id");
return undef;
}
if ($type != $etype) {
if ($type == SSH2_FXP_STATUS) {
my $code = $msg->get_int32;
my $str = Encode::decode(utf8 => $msg->get_str);
my $status = $sftp->_set_status($code, (defined $str ? $str : ()));
$sftp->_set_error($err, $errstr, $status);
}
else {
$sftp->_conn_lost(SSH2_FX_BAD_MESSAGE,
SFTP_ERR_REMOTE_BAD_MESSAGE,
$errstr, "bad packet type, expected $etype packet, got $type");
}
return undef;
}
}
$msg;
}
# reads SSH2_FXP_HANDLE packet and returns handle, or undef on failure
sub _get_handle {
my ($sftp, $eid, $error, $errstr) = @_;
if (my $msg = $sftp->_get_msg_and_check(SSH2_FXP_HANDLE, $eid,
$error, $errstr)) {
return $msg->get_str;
}
return undef;
}
sub _rid {
my ($sftp, $rfh) = @_;
my $rid = $rfh->_rid;
unless (defined $rid) {
$sftp->_set_error(SFTP_ERR_REMOTE_ACCESING_CLOSED_FILE,
"Couldn't access a file that has been previosly closed");
}
$rid
}
sub _rfid {
$_[1]->_check_is_file;
&_rid;
}
sub _rdid {
$_[1]->_check_is_dir;
&_rid;
}
sub _queue_rid_request {
my ($sftp, $code, $fh, $attrs) = @_;
my $rid = $sftp->_rid($fh);
return undef unless defined $rid;
$sftp->_queue_new_msg($code, str => $rid,
(defined $attrs ? (attr => $attrs) : ()));
}
sub _queue_rfid_request {
$_[2]->_check_is_file;
&_queue_rid_request;
}
sub _queue_rdid_request {
$_[2]->_check_is_dir;
&_queue_rid_request;
}
sub _queue_str_request {
my($sftp, $code, $str, $attrs) = @_;
$sftp->_queue_new_msg($code, str => $str,
(defined $attrs ? (attr => $attrs) : ()));
}
sub _check_status_ok {
my ($sftp, $eid, $error, $errstr) = @_;
if (my $msg = $sftp->_get_msg_and_check(SSH2_FXP_STATUS, $eid,
$error, $errstr)) {
my $status = $sftp->_set_status($msg->get_int32, $msg->get_str);
return 1 if $status == SSH2_FX_OK;
$sftp->_set_error($error, $errstr, $status);
}
return undef;
}
sub setcwd {
@_ <= 2 or croak 'Usage: $sftp->setcwd($path)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $cwd) = @_;
$sftp->_clear_error_and_status;
if (defined $cwd) {
$cwd = $sftp->realpath($cwd);
return undef unless defined $cwd;
my $a = $sftp->stat($cwd)
or return undef;
if (_is_dir($a->perm)) {
return $sftp->{cwd} = $cwd;
}
else {
$sftp->_set_error(SFTP_ERR_REMOTE_BAD_OBJECT,
"Remote object '$cwd' is not a directory");
return undef;
}
}
else {
delete $sftp->{cwd};
return $sftp->cwd if defined wantarray;
}
}
sub cwd {
@_ == 1 or croak 'Usage: $sftp->cwd()';
my $sftp = shift;
return defined $sftp->{cwd} ? $sftp->{cwd} : $sftp->realpath('');
}
## SSH2_FXP_OPEN (3)
# returns handle on success, undef on failure
sub open {
(@_ >= 2 and @_ <= 4)
or croak 'Usage: $sftp->open($path [, $flags [, $attrs]])';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $path, $flags, $a) = @_;
$path = $sftp->_rel2abs($path);
defined $flags or $flags = SSH2_FXF_READ;
defined $a or $a = Net::SFTP::Foreign::Attributes->new;
my $id = $sftp->_queue_new_msg(SSH2_FXP_OPEN,
str => $sftp->_fs_encode($path),
int32 => $flags, attr => $a);
my $rid = $sftp->_get_handle($id,
SFTP_ERR_REMOTE_OPEN_FAILED,
"Couldn't open remote file '$path'");
if ($debug and $debug & 2) {
_debug("new remote file '$path' open, rid:");
_hexdump($rid);
}
defined $rid
or return undef;
my $fh = Net::SFTP::Foreign::FileHandle->_new_from_rid($sftp, $rid);
$fh->_flag(append => 1) if ($flags & SSH2_FXF_APPEND);
$fh;
}
## SSH2_FXP_OPENDIR (11)
sub opendir {
@_ == 2 or croak 'Usage: $sftp->opendir($path)';
${^TAINT} and &_catch_tainted_args;
my $sftp = shift;
my $path = shift;
$path = $sftp->_rel2abs($path);
my $id = $sftp->_queue_str_request(SSH2_FXP_OPENDIR, $sftp->_fs_encode($path), @_);
my $rid = $sftp->_get_handle($id, SFTP_ERR_REMOTE_OPENDIR_FAILED,
"Couldn't open remote dir '$path'");
if ($debug and $debug & 2) {
_debug("new remote dir '$path' open, rid:");
_hexdump($rid);
}
defined $rid
or return undef;
Net::SFTP::Foreign::DirHandle->_new_from_rid($sftp, $rid, 0)
}
## SSH2_FXP_READ (4)
# returns data on success undef on failure
sub sftpread {
(@_ >= 3 and @_ <= 4)
or croak 'Usage: $sftp->sftpread($fh, $offset [, $size])';
my ($sftp, $rfh, $offset, $size) = @_;
unless ($size) {
return '' if defined $size;
$size = $sftp->{_block_size};
}
my $rfid = $sftp->_rfid($rfh);
defined $rfid or return undef;
my $id = $sftp->_queue_new_msg(SSH2_FXP_READ, str=> $rfid,
int64 => $offset, int32 => $size);
if (my $msg = $sftp->_get_msg_and_check(SSH2_FXP_DATA, $id,
SFTP_ERR_REMOTE_READ_FAILED,
"Couldn't read from remote file")) {
return $msg->get_str;
}
return undef;
}
## SSH2_FXP_WRITE (6)
# returns true on success, undef on failure
sub sftpwrite {
@_ == 4 or croak 'Usage: $sftp->sftpwrite($fh, $offset, $data)';
my ($sftp, $rfh, $offset) = @_;
my $rfid = $sftp->_rfid($rfh);
defined $rfid or return undef;
utf8::downgrade($_[3], 1) or croak "wide characters found in data";
my $id = $sftp->_queue_new_msg(SSH2_FXP_WRITE, str => $rfid,
int64 => $offset, str => $_[3]);
if ($sftp->_check_status_ok($id,
SFTP_ERR_REMOTE_WRITE_FAILED,
"Couldn't write to remote file")) {
return 1;
}
return undef;
}
sub seek {
(@_ >= 3 and @_ <= 4)
or croak 'Usage: $sftp->seek($fh, $pos [, $whence])';
my ($sftp, $rfh, $pos, $whence) = @_;
$sftp->flush($rfh) or return undef;
$whence ||= 0;
if ($whence == 0) {
return $rfh->_pos($pos)
}
elsif ($whence == 1) {
return $rfh->_inc_pos($pos)
}
elsif ($whence == 2) {
if (my $a = $sftp->fstat($rfh)) {
return $rfh->_pos($pos + $a->size);
}
else {
return undef;
}
}
else {
croak "invalid whence argument";
}
}
sub tell {
@_ == 2 or croak 'Usage: $sftp->tell($fh)';
my ($sftp, $rfh) = @_;
return $rfh->_pos + length ${$rfh->_bout};
}
sub eof {
@_ == 2 or croak 'Usage: $sftp->eof($fh)';
my ($sftp, $rfh) = @_;
$sftp->_fill_read_cache($rfh, 1);
return length(${$rfh->_bin}) == 0
}
sub _write {
my ($sftp, $rfh, $off, $cb) = @_;
$sftp->_clear_error_and_status;
my $rfid = $sftp->_rfid($rfh);
defined $rfid or return undef;
my $qsize = $sftp->{_queue_size};
my @msgid;
my @written;
my $written = 0;
my $end;
while (!$end or @msgid) {
while (!$end and @msgid < $qsize) {
my $data = $cb->();
if (defined $data and length $data) {
my $id = $sftp->_queue_new_msg(SSH2_FXP_WRITE, str => $rfid,
int64 => $off + $written, str => $data);
push @written, $written;
$written += length $data;
push @msgid, $id;
}
else {
$end = 1;
}
}
my $eid = shift @msgid;
my $last = shift @written;
unless ($sftp->_check_status_ok($eid,
SFTP_ERR_REMOTE_WRITE_FAILED,
"Couldn't write to remote file")) {
# discard responses to queued requests:
$sftp->_get_msg for @msgid;
return $last;
}
}
return $written;
}
sub write {
@_ == 3 or croak 'Usage: $sftp->write($fh, $data)';
my ($sftp, $rfh) = @_;
$sftp->flush($rfh, 'in') or return undef;
utf8::downgrade($_[2], 1) or croak "wide characters found in data";
my $datalen = length $_[2];
my $bout = $rfh->_bout;
$$bout .= $_[2];
my $len = length $$bout;
$sftp->flush($rfh, 'out')
if ($len >= $sftp->{_write_delay} or ($len and $sftp->{_autoflush} ));
return $datalen;
}
sub flush {
(@_ >= 2 and @_ <= 3)
or croak 'Usage: $sftp->flush($fh [, $direction])';
my ($sftp, $rfh, $dir) = @_;
$dir ||= '';
if ($dir ne 'out') { # flush in!
${$rfh->_bin} = '';
}
if ($dir ne 'in') { # flush out!
my $bout = $rfh->_bout;
my $len = length $$bout;
if ($len) {
my $start;
my $append = $rfh->_flag('append');
if ($append) {
my $attr = $sftp->fstat($rfh)
or return undef;
$start = $attr->size;
}
else {
$start = $rfh->_pos;
${$rfh->_bin} = '';
}
my $off = 0;
my $written = $sftp->_write($rfh, $start,
sub {
my $data = substr($$bout, $off, $sftp->{_block_size});
$off += length $data;
$data;
} );
$rfh->_inc_pos($written)
unless $append;
substr($$bout, 0, $written, '');
$written == $len or return undef;
}
}
1;
}
sub _fill_read_cache {
my ($sftp, $rfh, $len) = @_;
$sftp->_clear_error_and_status;
$sftp->flush($rfh, 'out')
or return undef;
my $rfid = $sftp->_rfid($rfh);
defined $rfid or return undef;
my $bin = $rfh->_bin;
if (defined $len) {
return 1 if ($len < length $$bin);
my $read_ahead = $sftp->{_read_ahead};
$len = length($$bin) + $read_ahead
if $len - length($$bin) < $read_ahead;
}
my $pos = $rfh->_pos;
my $qsize = $sftp->{_queue_size};
my $bsize = $sftp->{_block_size};
my @msgid;
my $askoff = length $$bin;
my $eof;
while (!defined $len or length $$bin < $len) {
while ((!defined $len or $askoff < $len) and @msgid < $qsize) {
my $id = $sftp->_queue_new_msg(SSH2_FXP_READ, str=> $rfid,
int64 => $pos + $askoff, int32 => $bsize);
push @msgid, $id;
$askoff += $bsize;
}
my $eid = shift @msgid;
my $msg = $sftp->_get_msg_and_check(SSH2_FXP_DATA, $eid,
SFTP_ERR_REMOTE_READ_FAILED,
"Couldn't read from remote file")
or last;
my $data = $msg->get_str;
$$bin .= $data;
if (length $data < $bsize) {
unless (defined $len) {
$eof = $sftp->_queue_new_msg(SSH2_FXP_READ, str=> $rfid,
int64 => $pos + length $$bin, int32 => 1);
}
last;
}
}
$sftp->_get_msg for @msgid;
if ($eof) {
$sftp->_get_msg_and_check(SSH2_FXP_DATA, $eof,
SFTP_ERR_REMOTE_BLOCK_TOO_SMALL,
"received block was too small")
}
if ($sftp->{_status} == SSH2_FX_EOF and length $$bin) {
$sftp->_clear_error_and_status;
}
return $sftp->{_error} ? undef : length $$bin;
}
sub read {
@_ == 3 or croak 'Usage: $sftp->read($fh, $len)';
my ($sftp, $rfh, $len) = @_;
if ($sftp->_fill_read_cache($rfh, $len)) {
my $bin = $rfh->_bin;
my $data = substr($$bin, 0, $len, '');
$rfh->_inc_pos(length $data);
return $data;
}
return undef;
}
sub _readline {
my ($sftp, $rfh, $sep) = @_;
$sep = "\n" if @_ < 3;
my $sl = length $sep;
my $bin = $rfh->_bin;
my $last = 0;
while(1) {
my $ix = index $$bin, $sep, $last + 1 - $sl ;
if ($ix >= 0) {
$ix += $sl;
$rfh->_inc_pos($ix);
return substr($$bin, 0, $ix, '');
}
$last = length $$bin;
$sftp->_fill_read_cache($rfh, length($$bin) + 1);
unless (length $$bin > $last) {
$sftp->{_error}
and return undef;
my $line = $$bin;
$rfh->_inc_pos(length $line);
$$bin = '';
return $line;
}
}
}
sub readline {
(@_ >= 2 and @_ <= 3)
or croak 'Usage: $sftp->readline($fh [, $sep])';
my ($sftp, $rfh, $sep) = @_;
$sep = "\n" if @_ < 3;
if (!defined $sep or $sep eq '') {
$sftp->_fill_read_cache($rfh);
$sftp->{_error}
and return undef;
my $bin = $rfh->_bin;
my $line = $$bin;
$rfh->_inc_pos(length $line);
$$bin = '';
return $line;
}
if (wantarray) {
my @lines;
while (defined (my $line = $sftp->_readline($rfh, $sep))) {
push @lines, $line;
}
return @lines;
}
return $sftp->_readline($rfh, $sep);
}
sub getc {
@_ == 2 or croak 'Usage: $sftp->getc($fh)';
my ($sftp, $rfh) = @_;
$sftp->_fill_read_cache($rfh, 1);
my $bin = $rfh->_bin;
if (length $bin) {
$rfh->_inc_pos(1);
return substr $$bin, 0, 1, '';
}
return undef;
}
sub _gen_stat_method {
my ($code, $error, $errstr) = @_;
return sub {
@_ == 2 or croak 'Usage: $sftp->stat|lstat($path)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $path) = @_;
$path = $sftp->_rel2abs($path);
my $id = $sftp->_queue_str_request($code, $sftp->_fs_encode($path));
if (my $msg = $sftp->_get_msg_and_check(SSH2_FXP_ATTRS, $id,
$error, $errstr)) {
return $msg->get_attributes;
}
return undef;
};
}
## SSH2_FXP_LSTAT (7), SSH2_FXP_FSTAT (8), SSH2_FXP_STAT (17)
# these all return a Net::SFTP::Foreign::Attributes object on success, undef on failure
*lstat = _gen_stat_method(SSH2_FXP_LSTAT,
SFTP_ERR_REMOTE_LSTAT_FAILED,
"Couldn't stat remote file (lstat)");
*stat = _gen_stat_method(SSH2_FXP_STAT,
SFTP_ERR_REMOTE_FSTAT_FAILED,
"Couldn't stat remote file (stat)");
sub fstat {
@_ == 2 or croak 'Usage: $sftp->fstat($fh)';
${^TAINT} and &_catch_tainted_args;
my $sftp = shift;
my $id = $sftp->_queue_rfid_request(SSH2_FXP_FSTAT, @_);
defined $id or return undef;
if (my $msg = $sftp->_get_msg_and_check(SSH2_FXP_ATTRS, $id,
SFTP_ERR_REMOTE_STAT_FAILED,
"Couldn't stat remote file (fstat)")) {
return $msg->get_attributes;
}
return undef;
}
## SSH2_FXP_RMDIR (15), SSH2_FXP_REMOVE (13)
# these return true on success, undef on failure
sub _gen_remove_method {
my($code, $error, $errstr) = @_;
return sub {
@_ == 2 or croak 'Usage: $sftp->remove|rmdir($path)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $path) = @_;
$path = $sftp->_rel2abs($path);
my $id = $sftp->_queue_str_request($code, $sftp->_fs_encode($path));
return $sftp->_check_status_ok($id, $error, $errstr);
};
}
*remove = _gen_remove_method(SSH2_FXP_REMOVE,
SFTP_ERR_REMOTE_REMOVE_FAILED,
"Couldn't delete remote file");
*rmdir = _gen_remove_method(SSH2_FXP_RMDIR,
SFTP_ERR_REMOTE_RMDIR_FAILED,
"Couldn't remove remote directory");
## SSH2_FXP_MKDIR (14), SSH2_FXP_SETSTAT (9)
# these return true on success, undef on failure
sub mkdir {
(@_ >= 2 and @_ <= 3)
or croak 'Usage: $sftp->mkdir($path [, $attrs])';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $path, $attrs) = @_;
$attrs = _empty_attributes unless defined $attrs;
$path = $sftp->_rel2abs($path);
my $id = $sftp->_queue_str_request(SSH2_FXP_MKDIR,
$sftp->_fs_encode($path),
$attrs);
return $sftp->_check_status_ok($id,
SFTP_ERR_REMOTE_MKDIR_FAILED,
"Couldn't create remote directory");
}
sub join {
my $sftp = shift;
my $a = '.';
while (@_) {
my $b = shift;
if (defined $b) {
$b =~ s|^(?:\./+)+||;
if (length $b and $b ne '.') {
if ($b !~ m|^/| and $a ne '.' ) {
$a = ($a =~ m|/$| ? "$a$b" : "$a/$b");
}
else {
$a = $b
}
$a =~ s|(?:/+\.)+/?$|/|;
$a =~ s|(?<=[^/])/+$||;
$a = '.' unless length $a;
}
}
}
$a;
}
sub _rel2abs {
my ($sftp, $path) = @_;
my $old = $path;
my $cwd = $sftp->{cwd};
$path = $sftp->join($sftp->{cwd}, $path);
$debug and $debug & 4096 and _debug("'$old' --> '$path'");
return $path
}
sub mkpath {
(@_ >= 2 and @_ <= 3)
or croak 'Usage: $sftp->mkpath($path [, $attrs])';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $path, $attrs) = @_;
$sftp->_clear_error_and_status;
$path =~ s{^(/*)}{};
my $start = $1;
my @path;
while (1) {
my $p = "$start$path";
$debug and $debug & 8192 and _debug "checking $p";
if ($sftp->test_d($p)) {
$debug and $debug & 8192 and _debug "$p is a dir";
last;
}
unless (length $path) {
$sftp->_set_error(SFTP_ERR_REMOTE_MKDIR_FAILED,
"Unable to make path, bad root");
return undef;
}
unshift @path, $p;
$path =~ s{/*[^/]*$}{};
}
for my $p (@path) {
$debug and $debug & 8192 and _debug "mkdir $p";
if ($p =~ m{^(?:.*/)?\.{1,2}$} or $p =~ m{/$}) {
$debug and $debug & 8192 and _debug "$p is a symbolic dir, skipping";
unless ($sftp->test_d($p)) {
$debug and $debug & 8192 and _debug "symbolic dir $p can not be checked";
$sftp->error or
$sftp->_set_error(SFTP_ERR_REMOTE_MKDIR_FAILED,
"Unable to make path, bad name");
return undef;
}
}
else {
$sftp->mkdir($p, $attrs)
or return undef;
}
}
1;
}
sub setstat {
@_ == 3 or croak 'Usage: $sftp->setstat($str, $attrs)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $path, $attrs) = @_;
$path = $sftp->_rel2abs($path);
my $id = $sftp->_queue_str_request(SSH2_FXP_SETSTAT,
$sftp->_fs_encode($path),
$attrs);
return $sftp->_check_status_ok($id,
SFTP_ERR_REMOTE_SETSTAT_FAILED,
"Couldn't setstat remote file (setstat)'");
}
## SSH2_FXP_CLOSE (4), SSH2_FXP_FSETSTAT (10)
# these return true on success, undef on failure
sub fsetstat {
@_ == 3 or croak 'Usage: $sftp->fsetstat($fh, $attrs)';
${^TAINT} and &_catch_tainted_args;
my $sftp = shift;
my $id = $sftp->_queue_rid_request(SSH2_FXP_FSETSTAT, @_);
defined $id or return undef;
return $sftp->_check_status_ok($id,
SFTP_ERR_REMOTE_FSETSTAT_FAILED,
"Couldn't setstat remote file (fsetstat)");
}
sub _close {
@_ == 2 or croak 'Usage: $sftp->close($fh, $attrs)';
my $sftp = shift;
my $id = $sftp->_queue_rid_request(SSH2_FXP_CLOSE, @_);
defined $id or return undef;
my $ok = $sftp->_check_status_ok($id,
SFTP_ERR_REMOTE_CLOSE_FAILED,
"Couldn't close remote file");
if ($debug and $debug & 2) {
_debug sprintf("closing file handle, return: %s, rid:", (defined $ok ? $ok : '-'));
_hexdump($sftp->_rid($_[0]));
}
return $ok;
}
sub close {
@_ == 2 or croak 'Usage: $sftp->close($fh)';
my ($sftp, $rfh) = @_;
$rfh->_check_is_file;
$sftp->flush($rfh)
or return undef;
if ($sftp->_close($rfh)) {
$rfh->_close;
return 1
}
undef
}
sub closedir {
@_ == 2 or croak 'Usage: $sftp->closedir($dh)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $rdh) = @_;
$rdh->_check_is_dir;
if ($sftp->_close($rdh)) {
$rdh->_close;
return 1;
}
undef
}
sub readdir {
@_ == 2 or croak 'Usage: $sftp->readdir($dh)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $rdh) = @_;
my $rdid = $sftp->_rdid($rdh);
defined $rdid or return undef;
my $cache = $rdh->_cache;
while (!@$cache or wantarray) {
my $id = $sftp->_queue_str_request(SSH2_FXP_READDIR, $rdid);
if (my $msg = $sftp->_get_msg_and_check(SSH2_FXP_NAME, $id,
SFTP_ERR_REMOTE_READDIR_FAILED,
"Couldn't read remote directory" )) {
my $count = $msg->get_int32 or last;
for (1..$count) {
push @$cache, { filename => $sftp->_fs_decode($msg->get_str),
longname => $sftp->_fs_decode($msg->get_str),
a => $msg->get_attributes };
}
}
else {
$sftp->_set_error if $sftp->status == SSH2_FX_EOF;
last;
}
}
if (wantarray) {
my $old = $cache;
$cache = [];
return @$old;
}
shift @$cache;
}
sub _readdir {
my ($sftp, $rdh);
if (wantarray) {
my $line = $sftp->readdir($rdh);
if (defined $line) {
return $line->{filename};
}
}
else {
return map { $_->{filename} } $sftp->readdir($rdh);
}
}
sub _gen_getpath_method {
my ($code, $error, $name) = @_;
return sub {
@_ == 2 or croak 'Usage: $sftp->some_method($path)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $path) = @_;
$path = $sftp->_rel2abs($path);
my $id = $sftp->_queue_str_request($code, $sftp->_fs_encode($path));
if (my $msg = $sftp->_get_msg_and_check(SSH2_FXP_NAME, $id,
$error,
"Couldn't get $name for remote '$path'")) {
$msg->get_int32 > 0
and return $sftp->_fs_decode($msg->get_str);
$sftp->_set_error($error,
"Couldn't get $name for remote '$path', no names on reply")
}
return undef;
};
}
## SSH2_FXP_REALPATH (16)
## SSH2_FXP_READLINK (19)
# return path on success, undef on failure
*realpath = _gen_getpath_method(SSH2_FXP_REALPATH,
SFTP_ERR_REMOTE_REALPATH_FAILED,
"realpath");
*readlink = _gen_getpath_method(SSH2_FXP_READLINK,
SFTP_ERR_REMOTE_READLINK_FAILED,
"link target");
## SSH2_FXP_RENAME (18)
# true on success, undef on failure
sub _rename {
my ($sftp, $old, $new) = @_;
$old = $sftp->_rel2abs($old);
$new = $sftp->_rel2abs($new);
my $id = $sftp->_queue_new_msg(SSH2_FXP_RENAME,
str => $sftp->_fs_encode($old),
str => $sftp->_fs_encode($new));
$sftp->_check_status_ok($id, SFTP_ERR_REMOTE_RENAME_FAILED,
"Couldn't rename remote file '$old' to '$new'");
}
sub rename {
(@_ & 1) or croak 'Usage: $sftp->rename($old, $new, %opts)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $old, $new, %opts) = @_;
my $overwrite = delete $opts{overwrite};
my $numbered = delete $opts{numbered};
croak "'overwrite' and 'numbered' options can not be used together"
if ($overwrite and $numbered);
%opts and _croak_bad_options(keys %opts);
if ($overwrite) {
$sftp->atomic_rename($old, $new) and return 1;
$sftp->status != SSH2_FX_OP_UNSUPPORTED and return undef;
}
for (1) {
local $sftp->{_autodie};
# we are optimistic here and try to rename it without testing
# if a file of the same name already exists first
if (!$sftp->_rename($old, $new) and
$sftp->status == SSH2_FX_FAILURE) {
if ($numbered and $sftp->test_e($new)) {
_inc_numbered($new);
redo;
}
elsif ($overwrite) {
my $rp_old = $sftp->realpath($old);
my $rp_new = $sftp->realpath($new);
if (defined $rp_old and defined $rp_new and $rp_old eq $rp_new) {
$sftp->_clear_error;
}
elsif ($sftp->remove($new)) {
$overwrite = 0;
redo;
}
}
}
}
$sftp->_ok_or_autodie;
}
sub atomic_rename {
@_ == 3 or croak 'Usage: $sftp->atomic_rename($old, $new)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $old, $new) = @_;
$sftp->_check_extension('posix-rename@openssh.com' => 1,
SFTP_ERR_REMOTE_RENAME_FAILED,
"atomic rename failed")
or return undef;
$old = $sftp->_rel2abs($old);
$new = $sftp->_rel2abs($new);
my $id = $sftp->_queue_new_msg(SSH2_FXP_EXTENDED,
str => 'posix-rename@openssh.com',
str => $sftp->_fs_encode($old),
str => $sftp->_fs_encode($new));
$sftp->_check_status_ok($id, SFTP_ERR_REMOTE_RENAME_FAILED,
"Couldn't rename remote file '$old' to '$new'");
}
## SSH2_FXP_SYMLINK (20)
# true on success, undef on failure
sub symlink {
@_ == 3 or croak 'Usage: $sftp->symlink($sl, $target)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $sl, $target) = @_;
$sl = $sftp->_rel2abs($sl);
my $id = $sftp->_queue_new_msg(SSH2_FXP_SYMLINK,
str => $sftp->_fs_encode($target),
str => $sftp->_fs_encode($sl));
$sftp->_check_status_ok($id, SFTP_ERR_REMOTE_SYMLINK_FAILED,
"Couldn't create symlink '$sl' pointing to '$target'");
}
sub hardlink {
@_ == 3 or croak 'Usage: $sftp->hardlink($hl, $target)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $hl, $target) = @_;
$sftp->_check_extension('hardlink@openssh.com' => 1,
SFTP_ERR_REMOTE_HARDLINK_FAILED,
"hardlink failed")
or return undef;
$hl = $sftp->_rel2abs($hl);
$target = $sftp->_rel2abs($target);
my $id = $sftp->_queue_new_msg(SSH2_FXP_EXTENDED,
str => 'hardlink@openssh.com',
str => $sftp->_fs_encode($target),
str => $sftp->_fs_encode($hl));
$sftp->_check_status_ok($id, SFTP_ERR_REMOTE_HARDLINK_FAILED,
"Couldn't create hardlink '$hl' pointing to '$target'");
}
sub _gen_save_status_method {
my $method = shift;
sub {
my $sftp = shift;
local ($sftp->{_error}, $sftp->{_status}) if $sftp->{_error};
$sftp->$method(@_);
}
}
*_close_save_status = _gen_save_status_method('close');
*_closedir_save_status = _gen_save_status_method('closedir');
*_remove_save_status = _gen_save_status_method('remove');
sub _inc_numbered {
$_[0] =~ s{^(.*)\((\d+)\)((?:\.[^\.]*)?)$}{"$1(" . ($2+1) . ")$3"}e or
$_[0] =~ s{((?:\.[^\.]*)?)$}{(1)$1};
$debug and $debug & 128 and _debug("numbering to: $_[0]");
}
## High-level client -> server methods.
sub abort {
my $sftp = shift;
$sftp->_set_error(SFTP_ERR_ABORTED, ($@ ? $_[0] : "Aborted"));
}
# returns true on success, undef on failure
sub get {
@_ >= 2 or croak 'Usage: $sftp->get($remote, $local, %opts)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $remote, $local, %opts) = @_;
defined $remote or croak "remote file path is undefined";
$sftp->_clear_error_and_status;
$remote = $sftp->_rel2abs($remote);
$local = _file_part($remote) unless defined $local;
my $local_is_fh = (ref $local and $local->isa('GLOB'));
my $cb = delete $opts{callback};
my $umask = delete $opts{umask};
my $perm = delete $opts{perm};
my $copy_perm = delete $opts{exists $opts{copy_perm} ? 'copy_perm' : 'copy_perms'};
my $copy_time = delete $opts{copy_time};
my $overwrite = delete $opts{overwrite};
my $resume = delete $opts{resume};
my $append = delete $opts{append};
my $block_size = delete $opts{block_size} || $sftp->{_block_size};
my $queue_size = delete $opts{queue_size} || $sftp->{_queue_size};
my $dont_save = delete $opts{dont_save};
my $conversion = delete $opts{conversion};
my $numbered = delete $opts{numbered};
my $cleanup = delete $opts{cleanup};
my $atomic = delete $opts{atomic};
croak "'perm' and 'umask' options can not be used simultaneously"
if (defined $perm and defined $umask);
croak "'perm' and 'copy_perm' options can not be used simultaneously"
if (defined $perm and defined $copy_perm);
croak "'resume' and 'append' options can not be used simultaneously"
if ($resume and $append);
croak "'numbered' can not be used with 'overwrite', 'resume' or 'append'"
if ($numbered and ($overwrite or $resume or $append));
croak "'atomic' can not be used with 'resume' or 'append'"
if ($atomic and ($resume or $append));
if ($local_is_fh) {
my $append = 'option can not be used when target is a file handle';
$resume and croak "'resume' $append";
$overwrite and croak "'overwrite' $append";
$numbered and croak "'numbered' $append";
$dont_save and croak "'dont_save' $append";
$atomic and croak "'croak' $append";
}
%opts and _croak_bad_options(keys %opts);
if ($resume and $conversion) {
carp "resume option is useless when data conversion has also been requested";
undef $resume;
}
my $oldumask = umask;
my $neg_umask;
if (defined $perm) {
$neg_umask = $perm;
}
else {
$umask = $oldumask unless defined $umask;
$neg_umask = 0777 & ~$umask;
}
$overwrite = 1 unless (defined $overwrite or $local_is_fh or $numbered);
$copy_perm = 1 unless (defined $perm or defined $copy_perm or $local_is_fh);
$copy_time = 1 unless (defined $copy_time or $local_is_fh);
$cleanup = ($atomic || $numbered) unless defined $cleanup;
my $a = do {
local $sftp->{_autodie};
$sftp->stat($remote);
};
my ($rperm, $size, $atime, $mtime) = ($a ? ($a->perm, $a->size, $a->atime, $a->mtime) : ());
$size = -1 unless defined $size;
if ($copy_time and not defined $atime) {
$sftp->_ok_or_autodie and $sftp->_set_error(SFTP_ERR_REMOTE_STAT_FAILED,
"Not enough information on stat, amtime not included");
return undef;
}
if ($copy_perm) {
if (defined $rperm) {
$perm = $rperm;
}
else {
$sftp->_ok_or_autodie and $sftp->_set_error(SFTP_ERR_REMOTE_STAT_FAILED,
"Not enough information on stat, mode not included");
return undef
}
}
$sftp->_clear_error_and_status;
if ($resume and $resume eq 'auto') {
undef $resume;
if (defined $mtime) {
if (my @lstat = CORE::stat $local) {
$resume = ($mtime <= $lstat[9]);
}
}
}
my ($atomic_numbered, $atomic_local, $atomic_cleanup);
my ($rfh, $fh);
my $askoff = 0;
my $lstart = 0;
if ($dont_save) {
$rfh = $sftp->open($remote, SSH2_FXF_READ);
defined $rfh or return undef;
}
else {
unless ($local_is_fh or $overwrite or $append or $resume or $numbered) {
if (-e $local) {
$sftp->_set_error(SFTP_ERR_LOCAL_ALREADY_EXISTS,
"local file $local already exists");
return undef
}
}
if ($atomic) {
$atomic_local = $local;
$local .= sprintf("(%d).tmp", rand(10000));
$atomic_numbered = $numbered;
$numbered = 1;
$debug and $debug & 128 and _debug("temporal local file name: $local");
}
$perm = (0666 & $neg_umask) unless defined $perm or $local_is_fh;
if ($resume) {
if (CORE::open $fh, '+<', $local) {
binmode $fh;
CORE::seek($fh, 0, 2);
$askoff = CORE::tell $fh;
if ($askoff < 0) {
# something is going really wrong here, fall
# back to non-resuming mode...
$askoff = 0;
undef $fh;
}
else {
if ($size >=0 and $askoff > $size) {
$sftp->_set_error(SFTP_ERR_LOCAL_BIGGER_THAN_REMOTE,
"Couldn't resume transfer, local file is bigger than remote");
return undef;
}
$size == $askoff and return 1;
}
}
}
# we open the remote file so late in order to skip it when
# resuming an already completed transfer:
$rfh = $sftp->open($remote, SSH2_FXF_READ);
defined $rfh or return undef;
unless (defined $fh) {
if ($local_is_fh) {
$fh = $local;
local ($@, $SIG{__DIE__}, $SIG{__WARN__});
eval { $lstart = CORE::tell($fh) };
$lstart = 0 unless ($lstart and $lstart > 0);
}
else {
my $flags = Fcntl::O_CREAT|Fcntl::O_WRONLY;
$flags |= Fcntl::O_APPEND if $append;
$flags |= Fcntl::O_EXCL if ($numbered or (!$overwrite and !$append));
my $lumask = ~$perm & 0777;
unlink $local if ($overwrite and !$numbered);
while (1) {
umask $lumask;
sysopen ($fh, $local, $flags, $perm) and last;
my $err = $!;
umask $oldumask;
unless ($numbered and -e $local) {
$sftp->_set_error(SFTP_ERR_LOCAL_OPEN_FAILED,
"Can't open $local", $err);
return undef;
}
_inc_numbered($local);
}
umask $oldumask;
$$numbered = $local if ref $numbered;
binmode $fh;
$lstart = sysseek($fh, 0, 1) if $append;
}
}
if (defined $perm) {
local ($@, $SIG{__DIE__}, $SIG{__WARN__});
my $e = eval { chmod($perm & $neg_umask, $local) };
if ($@ or $e <= 0) {
my $err = $!;
unlink $local;
$sftp->_set_error(SFTP_ERR_LOCAL_CHMOD_FAILED,
"Can't chmod $local", ($@ ? $@ : $err));
return undef
}
}
}
my $converter = _gen_converter $conversion;
my $rfid = $sftp->_rfid($rfh);
defined $rfid or die "internal error: rfid not defined";
my @msgid;
my @askoff;
my $loff = $askoff;
my $adjustment = 0;
my $n = 0;
local $\;
do {
# Disable autodie here in order to do not leave unhandled
# responses queued on the connection in case of failure.
local $sftp->{_autodie};
# Again, once this point is reached, all code paths should end
# through the CLEANUP block.
while (1) {
# request a new block if queue is not full
while (!@msgid or (($size == -1 or $size > $askoff) and @msgid < $queue_size and $n != 1)) {
my $id = $sftp->_queue_new_msg(SSH2_FXP_READ, str=> $rfid,
int64 => $askoff, int32 => $block_size);
push @msgid, $id;
push @askoff, $askoff;
$askoff += $block_size;
$n++;
}
my $eid = shift @msgid;
my $roff = shift @askoff;
my $msg = $sftp->_get_msg_and_check(SSH2_FXP_DATA, $eid,
SFTP_ERR_REMOTE_READ_FAILED,
"Couldn't read from remote file");
unless ($msg) {
if ($sftp->{_status} == SSH2_FX_EOF) {
$sftp->_set_error();
$roff != $loff and next;
}
last;
}
my $data = $msg->get_str;
my $len = length $data;
if ($roff != $loff or !$len) {
$sftp->_set_error(SFTP_ERR_REMOTE_BLOCK_TOO_SMALL,
"remote packet received is too small" );
last;
}
$loff += $len;
if ($len < $block_size) {
$block_size = $len < 2048 ? 2048 : $len;
$askoff = $loff;
}
my $adjustment_before = $adjustment;
$adjustment += $converter->($data) if $converter;
if (length($data) and defined $cb) {
# $size = $loff if ($loff > $size and $size != -1);
$cb->($sftp, $data,
$lstart + $roff + $adjustment_before,
$lstart + $size + $adjustment);
last if $sftp->error;
}
if (length($data) and !$dont_save) {
unless (print $fh $data) {
$sftp->_set_error(SFTP_ERR_LOCAL_WRITE_FAILED,
"unable to write data to local file $local", $!);
last;
}
}
}
$sftp->_get_msg for (@msgid);
goto CLEANUP if $sftp->{_error};
# if a converter is in place, and aditional call has to be
# performed in order to flush any pending buffered data
if ($converter) {
my $data = '';
my $adjustment_before = $adjustment;
$adjustment += $converter->($data);
if (length($data) and defined $cb) {
# $size = $loff if ($loff > $size and $size != -1);
$cb->($sftp, $data, $askoff + $adjustment_before, $size + $adjustment);
goto CLEANUP if $sftp->{_error};
}
if (length($data) and !$dont_save) {
unless (print $fh $data) {
$sftp->_set_error(SFTP_ERR_LOCAL_WRITE_FAILED,
"unable to write data to local file $local", $!);
goto CLEANUP;
}
}
}
# we call the callback one last time with an empty string;
if (defined $cb) {
my $data = '';
$cb->($sftp, $data, $askoff + $adjustment, $size + $adjustment);
return undef if $sftp->error;
if (length($data) and !$dont_save) {
unless (print $fh $data) {
$sftp->_set_error(SFTP_ERR_LOCAL_WRITE_FAILED,
"unable to write data to local file $local", $!);
goto CLEANUP;
}
}
}
unless ($dont_save) {
unless ($local_is_fh or CORE::close $fh) {
$sftp->_set_error(SFTP_ERR_LOCAL_WRITE_FAILED,
"unable to write data to local file $local", $!);
goto CLEANUP;
}
# we can be running on taint mode, so some checks are
# performed to untaint data from the remote side.
if ($copy_time and not utime($atime, $mtime, $local)) {
$sftp->_set_error(SFTP_ERR_LOCAL_UTIME_FAILED,
"Can't utime $local", $!);
goto CLEANUP;
}
}
if ($atomic) {
if (!$overwrite) {
while (1) {
# performing a non-overwriting atomic rename is
# quite burdensome: first, link is tried, if that
# fails, non-overwriting is favoured over
# atomicity and an empty file is used to lock the
# path before atempting an overwriting rename.
if (link $local, $atomic_local) {
unlink $local;
last;
}
my $err = $!;
unless (-e $atomic_local) {
if (sysopen my $lock, $atomic_local,
Fcntl::O_CREAT|Fcntl::O_EXCL|Fcntl::O_WRONLY,
0600) {
$atomic_cleanup = 1;
goto OVERWRITE;
}
$err = $!;
unless (-e $atomic_local) {
$sftp->_set_error(SFTP_ERR_LOCAL_OPEN_FAILED,
"Can't open $local", $err);
goto CLEANUP;
}
}
unless ($numbered) {
$sftp->_set_error(SFTP_ERR_LOCAL_ALREADY_EXISTS,
"local file $atomic_local already exists");
goto CLEANUP;
}
_inc_numbered($atomic_local);
}
}
else {
OVERWRITE:
unless (CORE::rename $local, $atomic_local) {
$sftp->_set_error(SFTP_ERR_LOCAL_RENAME_FAILED,
"Unable to rename temporal file to its final position '$atomic_local'", $!);
goto CLEANUP;
}
}
$$atomic_numbered = $local if ref $atomic_numbered;
}
CLEANUP:
if ($cleanup and $sftp->{_error}) {
unlink $local;
unlink $atomic_local if $atomic_cleanup;
}
}; # autodie flag is restored here!
$sftp->_ok_or_autodie;
}
# return file contents on success, undef on failure
sub get_content {
@_ == 2 or croak 'Usage: $sftp->get_content($remote)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $name) = @_;
$name = $sftp->_rel2abs($name);
my @data;
my $rfh = $sftp->open($name)
or return undef;
scalar $sftp->readline($rfh, undef);
}
sub put {
@_ >= 2 or croak 'Usage: $sftp->put($local, $remote, %opts)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $local, $remote, %opts) = @_;
defined $local or croak "local file path is undefined";
$sftp->_clear_error_and_status;
my $local_is_fh = (ref $local and $local->isa('GLOB'));
unless (defined $remote) {
$local_is_fh and croak "unable to infer remote file name when a file handler is passed as local";
$remote = (File::Spec->splitpath($local))[2];
}
$remote = $sftp->_rel2abs($remote);
my $cb = delete $opts{callback};
my $umask = delete $opts{umask};
my $perm = delete $opts{perm};
my $copy_perm = delete $opts{copy_perm};
$copy_perm = delete $opts{copy_perms} unless defined $copy_perm;
my $copy_time = delete $opts{copy_time};
my $overwrite = delete $opts{overwrite};
my $resume = delete $opts{resume};
my $append = delete $opts{append};
my $block_size = delete $opts{block_size} || $sftp->{_block_size};
my $queue_size = delete $opts{queue_size} || $sftp->{_queue_size};
my $conversion = delete $opts{conversion};
my $late_set_perm = delete $opts{late_set_perm};
my $numbered = delete $opts{numbered};
my $atomic = delete $opts{atomic};
my $cleanup = delete $opts{cleanup};
croak "'perm' and 'umask' options can not be used simultaneously"
if (defined $perm and defined $umask);
croak "'perm' and 'copy_perm' options can not be used simultaneously"
if (defined $perm and $copy_perm);
croak "'resume' and 'append' options can not be used simultaneously"
if ($resume and $append);
croak "'resume' and 'overwrite' options can not be used simultaneously"
if ($resume and $overwrite);
croak "'numbered' can not be used with 'overwrite', 'resume' or 'append'"
if ($numbered and ($overwrite or $resume or $append));
croak "'atomic' can not be used with 'resume' or 'append'"
if ($atomic and ($resume or $append));
%opts and _croak_bad_options(keys %opts);
$overwrite = 1 unless (defined $overwrite or $numbered);
$copy_perm = 1 unless (defined $perm or defined $copy_perm or $local_is_fh);
$copy_time = 1 unless (defined $copy_time or $local_is_fh);
$late_set_perm = $sftp->{_late_set_perm} unless defined $late_set_perm;
$cleanup = ($atomic || $numbered) unless defined $cleanup;
my $neg_umask;
if (defined $perm) {
$neg_umask = $perm;
}
else {
$umask = umask unless defined $umask;
$neg_umask = 0777 & ~$umask;
}
my ($fh, $lmode, $lsize, $latime, $lmtime);
if ($local_is_fh) {
$fh = $local;
# we don't set binmode for the passed file handle on purpose
}
else {
unless (CORE::open $fh, '<', $local) {
$sftp->_set_error(SFTP_ERR_LOCAL_OPEN_FAILED,
"Unable to open local file '$local'", $!);
return undef;
}
binmode $fh;
}
{
# as $fh can come from the outside, it may be a tied object
# lacking support for some methods, so we call them wrapped
# inside eval blocks
local ($@, $SIG{__DIE__}, $SIG{__WARN__});
if ((undef, undef, $lmode, undef, undef,
undef, undef, $lsize, $latime, $lmtime) =
eval {
no warnings; # Calling stat on a tied handler
# generates a warning because the op is
# not supported by the tie API.
CORE::stat $fh;
}
) {
# $fh can point at some place inside the file, not just at the
# begining
if ($local_is_fh and defined $lsize) {
my $tell = eval { CORE::tell $fh };
$lsize -= $tell if ($tell and $tell > 0);
}
}
elsif ($copy_perm or $copy_time) {
$sftp->_set_error(SFTP_ERR_LOCAL_STAT_FAILED,
"Couldn't stat local file '$local'", $!);
return undef;
}
elsif ($resume and $resume eq 'auto') {
$debug and $debug & 16384 and _debug "not resuming because stat'ing the local file failed";
undef $resume
}
}
$perm = $lmode & $neg_umask if $copy_perm;
my $attrs = Net::SFTP::Foreign::Attributes->new;
$attrs->set_perm($perm) if defined $perm;
my $rfh;
my $writeoff = 0;
my $converter = _gen_converter $conversion;
my $converted_input = '';
if ($resume or $append) {
my $rattrs = $sftp->stat($remote);
if ($rattrs) {
if ($resume and $resume eq 'auto' and $rattrs->mtime >= $lmtime) {
$debug and $debug & 16384 and
_debug "not resuming because local file is newer, r: ".$rattrs->mtime." l: $lmtime";
undef $resume;
}
else {
$writeoff = $rattrs->size;
$debug and $debug & 16384 and _debug "resuming from $writeoff";
}
}
elsif ($append) {
return undef unless $sftp->status == SSH2_FX_NO_SUCH_FILE;
undef $append;
}
if ($resume and $writeoff) {
$debug and $debug & 16384 and _debug "resuming file transfer from $writeoff";
if ($converter) {
# as size could change, we have to read and convert
# data until we reach the given position on the local
# file:
my $off = 0;
my $eof_t;
while (1) {
my $len = length $converted_input;
my $delta = $writeoff - $off;
if ($delta <= $len) {
$debug and $debug & 16384 and _debug "discarding $delta converted bytes";
substr $converted_input, 0, $delta, '';
last;
}
else {
$off += $len;
if ($eof_t) {
$sftp->_set_error(SFTP_ERR_REMOTE_BIGGER_THAN_LOCAL,
"Couldn't resume transfer, remote file is bigger than local");
return undef;
}
my $read = CORE::read($fh, $converted_input, $block_size * 4);
unless (defined $read) {
$sftp->_set_error(SFTP_ERR_LOCAL_READ_ERROR,
"Couldn't read from local file '$local' to the resume point $writeoff", $!);
return undef;
}
$lsize += $converter->($converted_input) if defined $lsize;
utf8::downgrade($converted_input, 1)
or croak "converter introduced wide characters in data";
$read or $eof_t = 1;
}
}
}
elsif ($local_is_fh) {
# as some PerlIO layer could be installed on the $fh,
# just seeking to the resume position will not be
# enough. We have to read and discard data until the
# desired offset is reached
my $off = $writeoff;
while ($off) {
my $read = CORE::read($fh, my($buf), ($off < 16384 ? $off : 16384));
if ($read) {
$debug and $debug & 16384 and _debug "discarding $read bytes";
$off -= $read;
}
else {
$sftp->_set_error(defined $read
? ( SFTP_ERR_REMOTE_BIGGER_THAN_LOCAL,
"Couldn't resume transfer, remote file is bigger than local")
: ( SFTP_ERR_LOCAL_READ_ERROR,
"Couldn't read from local file handler '$local' to the resume point $writeoff", $!));
}
}
}
else {
if (defined $lsize and $writeoff > $lsize) {
$sftp->_set_error(SFTP_ERR_REMOTE_BIGGER_THAN_LOCAL,
"Couldn't resume transfer, remote file is bigger than local");
return undef;
}
unless (CORE::seek($fh, $writeoff, 0)) {
$sftp->_set_error(SFTP_ERR_LOCAL_SEEK_FAILED,
"seek operation on local file failed: $!");
return undef;
}
}
if (defined $lsize and $writeoff == $lsize) {
if (defined $perm and $rattrs->perm != $perm) {
return $sftp->setstat($remote, $attrs);
}
return 1;
}
$rfh = $sftp->open($remote, SSH2_FXF_WRITE)
or return undef;
}
}
my ($atomic_numbered, $atomic_remote);
unless (defined $rfh) {
if ($atomic) {
# check that does not exist a file of the same name that
# would block the rename operation at the end
if (!($numbered or $overwrite) and
$sftp->test_e($remote)) {
$sftp->_set_status(SSH2_FX_FAILURE);
$sftp->_set_error(SFTP_ERR_REMOTE_ALREADY_EXISTS,
"Remote file '$remote' already exists");
return undef;
}
$atomic_remote = $remote;
$remote .= sprintf("(%d).tmp", rand(10000));
$atomic_numbered = $numbered;
$numbered = 1;
$debug and $debug & 128 and _debug("temporal remote file name: $remote");
}
if ($numbered) {
while (1) {
local $sftp->{_autodie};
$rfh = $sftp->open($remote,
SSH2_FXF_WRITE | SSH2_FXF_CREAT | SSH2_FXF_EXCL,
$attrs);
last if ($rfh or
$sftp->status != SSH2_FX_FAILURE or
!$sftp->test_e($remote));
_inc_numbered($remote);
}
$sftp->_ok_or_autodie;
$$numbered = $remote if ref $numbered;
}
else {
$rfh = $sftp->open($remote,
SSH2_FXF_WRITE | SSH2_FXF_CREAT |
($append ? 0 : ($overwrite ? SSH2_FXF_TRUNC : SSH2_FXF_EXCL)),
$attrs)
or return undef;
}
}
$sftp->_ok_or_autodie or return undef;
# Once this point is reached and for the remaining of the sub,
# code should never return but jump into the CLEANUP block.
do {
local $sftp->{autodie};
# In some SFTP server implementations, open does not set the
# attributes for existent files so we do it again. The
# $late_set_perm work around is for some servers that do not
# support changing the permissions of open files
if (defined $perm and !$late_set_perm) {
$sftp->fsetstat($rfh, $attrs) or goto CLEANUP;
}
my $rfid = $sftp->_rfid($rfh);
defined $rfid or die "internal error: rfid is undef";
# In append mode we add the size of the remote file in
# writeoff, if lsize is undef, we initialize it to $writeoff:
$lsize += $writeoff if ($append or not defined $lsize);
# when a converter is used, the EOF can become delayed by the
# buffering introduced, we use $eof_t to account for that.
my ($eof, $eof_t);
my @msgid;
OK: while (1) {
if (!$eof and @msgid < $queue_size) {
my ($data, $len);
if ($converter) {
while (!$eof_t and length $converted_input < $block_size) {
my $read = CORE::read($fh, my $input, $block_size * 4);
unless ($read) {
unless (defined $read) {
$sftp->_set_error(SFTP_ERR_LOCAL_READ_ERROR,
"Couldn't read from local file '$local'", $!);
last OK;
}
$eof_t = 1;
}
# note that the $converter is called a last time
# with an empty string
$lsize += $converter->($input);
utf8::downgrade($input, 1)
or croak "converter introduced wide characters in data";
$converted_input .= $input;
}
$data = substr($converted_input, 0, $block_size, '');
$len = length $data;
$eof = 1 if ($eof_t and !$len);
}
else {
$debug and $debug & 16384 and
_debug "reading block at offset ".CORE::tell($fh)." block_size: $block_size";
$len = CORE::read($fh, $data, $block_size);
if ($len) {
$debug and $debug & 16384 and _debug "block read, size: $len";
utf8::downgrade($data, 1)
or croak "wide characters unexpectedly read from file";
$debug and $debug & 16384 and length $data != $len and
_debug "read data changed size on downgrade to " . length($data);
}
else {
unless (defined $len) {
$sftp->_set_error(SFTP_ERR_LOCAL_READ_ERROR,
"Couldn't read from local file '$local'", $!);
last OK;
}
$eof = 1;
}
}
my $nextoff = $writeoff + $len;
if (defined $cb) {
$lsize = $nextoff if $nextoff > $lsize;
$cb->($sftp, $data, $writeoff, $lsize);
last OK if $sftp->error;
utf8::downgrade($data, 1) or croak "callback introduced wide characters in data";
$len = length $data;
$nextoff = $writeoff + $len;
}
if ($len) {
$debug and $debug & 16384 and
_debug "writing block at offset $writeoff, length " . length($data);
my $id = $sftp->_queue_new_msg(SSH2_FXP_WRITE, str => $rfid,
int64 => $writeoff, str => $data);
push @msgid, $id;
$writeoff = $nextoff;
}
}
last if ($eof and !@msgid);
next unless ($eof
or @msgid >= $queue_size
or $sftp->_do_io(0));
my $id = shift @msgid;
unless ($sftp->_check_status_ok($id,
SFTP_ERR_REMOTE_WRITE_FAILED,
"Couldn't write to remote file")) {
last OK;
}
}
CORE::close $fh unless $local_is_fh;
$sftp->_get_msg for (@msgid);
$sftp->_close_save_status($rfh);
goto CLEANUP if $sftp->{_error};
# for servers that does not support setting permissions on open files
if (defined $perm and $late_set_perm) {
$sftp->setstat($remote, $attrs);
}
if ($copy_time) {
$attrs = Net::SFTP::Foreign::Attributes->new;
$attrs->set_amtime($latime, $lmtime);
$sftp->setstat($remote, $attrs) or goto CLEANUP;
}
if ($atomic) {
$sftp->rename($remote, $atomic_remote,
overwrite => $overwrite,
numbered => $atomic_numbered) or goto CLEANUP;
}
CLEANUP:
if ($cleanup and $sftp->{_error}) {
warn "cleanup $remote";
$sftp->_remove_save_status($remote);
}
};
$sftp->_ok_or_autodie;
}
sub ls {
@_ >= 1 or croak 'Usage: $sftp->ls($remote_dir, %opts)';
${^TAINT} and &_catch_tainted_args;
my $sftp = shift;
my %opts = @_ & 1 ? (dir => @_) : @_;
my $dir = delete $opts{dir};
my $ordered = delete $opts{ordered};
my $follow_links = delete $opts{follow_links};
my $atomic_readdir = delete $opts{atomic_readdir};
my $names_only = delete $opts{names_only};
my $realpath = delete $opts{realpath};
my $queue_size = delete $opts{queue_size};
my $cheap = ($names_only and !$realpath);
my ($cheap_wanted, $wanted);
if ($cheap and
ref $opts{wanted} eq 'RegExp' and
not defined $opts{no_wanted}) {
$cheap_wanted = delete $opts{wanted}
}
else {
$wanted = (delete $opts{_wanted} ||
_gen_wanted(delete $opts{wanted},
delete $opts{no_wanted}));
undef $cheap if defined $wanted;
}
%opts and _croak_bad_options(keys %opts);
my $delayed_wanted = ($atomic_readdir and $wanted);
$queue_size = 1 if ($follow_links or $realpath or
($wanted and not $delayed_wanted));
my $max_queue_size = $queue_size || $sftp->{_queue_size};
$queue_size ||= 2;
$dir = '.' unless defined $dir;
$dir = $sftp->_rel2abs($dir);
my $rdh = $sftp->opendir($dir);
return unless defined $rdh;
my $rdid = $sftp->_rdid($rdh);
defined $rdid or return undef;
my @dir;
my @msgid;
do {
local $sftp->{_autodie};
OK: while (1) {
push @msgid, $sftp->_queue_str_request(SSH2_FXP_READDIR, $rdid)
while (@msgid < $queue_size);
my $id = shift @msgid;
if (my $msg = $sftp->_get_msg_and_check(SSH2_FXP_NAME, $id,
SFTP_ERR_REMOTE_READDIR_FAILED,
"Couldn't read directory '$dir'" )) {
my $count = $msg->get_int32 or last;
if ($cheap) {
for (1..$count) {
my $fn = $sftp->_fs_decode($msg->get_str);
push @dir, $fn if (!defined $cheap_wanted or $fn =~ $cheap_wanted);
$msg->skip_str;
Net::SFTP::Foreign::Attributes->skip_from_buffer($msg);
}
}
else {
for (1..$count) {
my $fn = $sftp->_fs_decode($msg->get_str);
my $ln = $sftp->_fs_decode($msg->get_str);
# my $a = $msg->get_attributes;
my $a = Net::SFTP::Foreign::Attributes->new_from_buffer($msg);
my $entry = { filename => $fn,
longname => $ln,
a => $a };
if ($follow_links and _is_lnk($a->perm)) {
if ($a = $sftp->stat($sftp->join($dir, $fn))) {
$entry->{a} = $a;
}
else {
$sftp->_clear_error_and_status;
}
}
if ($realpath) {
my $rp = $sftp->realpath($sftp->join($dir, $fn));
if (defined $rp) {
$fn = $entry->{realpath} = $rp;
}
else {
$sftp->_clear_error_and_status;
}
}
if (!$wanted or $delayed_wanted or $wanted->($sftp, $entry)) {
push @dir, (($names_only and !$delayed_wanted) ? $fn : $entry);
}
}
}
$queue_size ++ if $queue_size < $max_queue_size;
}
else {
$sftp->_set_error if $sftp->{_status} == SSH2_FX_EOF;
$sftp->_get_msg for @msgid;
last;
}
}
$sftp->_closedir_save_status($rdh) if $rdh;
};
unless ($sftp->error) {
if ($delayed_wanted) {
@dir = grep { $wanted->($sftp, $_) } @dir;
@dir = map { defined $_->{realpath}
? $_->{realpath}
: $_->{filename} } @dir
if $names_only;
}
if ($ordered) {
if ($names_only) {
@dir = sort @dir;
}
else {
_sort_entries \@dir;
}
}
return \@dir;
}
croak $sftp->error if $sftp->{_autodie};
return undef;
}
sub rremove {
@_ >= 2 or croak 'Usage: $sftp->rremove($dirs, %opts)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $dirs, %opts) = @_;
my $on_error = delete $opts{on_error};
local $sftp->{_autodie} if $on_error;
my $wanted = _gen_wanted( delete $opts{wanted},
delete $opts{no_wanted});
%opts and _croak_bad_options(keys %opts);
my $count = 0;
my @dirs;
$sftp->find( $dirs,
on_error => $on_error,
atomic_readdir => 1,
wanted => sub {
my $e = $_[1];
my $fn = $e->{filename};
if (_is_dir($e->{a}->perm)) {
push @dirs, $e;
}
else {
if (!$wanted or $wanted->($sftp, $e)) {
if ($sftp->remove($fn)) {
$count++;
}
else {
$sftp->_call_on_error($on_error, $e);
}
}
}
} );
_sort_entries(\@dirs);
while (@dirs) {
my $e = pop @dirs;
if (!$wanted or $wanted->($sftp, $e)) {
if ($sftp->rmdir($e->{filename})) {
$count++;
}
else {
$sftp->_call_on_error($on_error, $e);
}
}
}
return $count;
}
sub get_symlink {
@_ >= 3 or croak 'Usage: $sftp->get_symlink($remote, $local, %opts)';
my ($sftp, $remote, $local, %opts) = @_;
my $overwrite = delete $opts{overwrite};
my $numbered = delete $opts{numbered};
croak "'overwrite' and 'numbered' can not be used together"
if ($overwrite and $numbered);
%opts and _croak_bad_options(keys %opts);
$overwrite = 1 unless (defined $overwrite or $numbered);
my $a = $sftp->lstat($remote) or return undef;
unless (_is_lnk($a->perm)) {
$sftp->_set_error(SFTP_ERR_REMOTE_BAD_OBJECT,
"Remote object '$remote' is not a symlink");
return undef;
}
my $link = $sftp->readlink($remote) or return undef;
# TODO: this is too weak, may contain race conditions.
if ($numbered) {
_inc_numbered($local) while -e $local;
}
elsif (-e $local) {
if ($overwrite) {
unlink $local;
}
else {
$sftp->_set_error(SFTP_ERR_LOCAL_ALREADY_EXISTS,
"local file $local already exists");
return undef
}
}
unless (eval { CORE::symlink $link, $local }) {
$sftp->_set_error(SFTP_ERR_LOCAL_SYMLINK_FAILED,
"creation of symlink '$local' failed", $!);
return undef;
}
$$numbered = $local if ref $numbered;
1;
}
sub put_symlink {
@_ >= 3 or croak 'Usage: $sftp->put_symlink($local, $remote, %opts)';
my ($sftp, $local, $remote, %opts) = @_;
my $overwrite = delete $opts{overwrite};
my $numbered = delete $opts{numbered};
croak "'overwrite' and 'numbered' can not be used together"
if ($overwrite and $numbered);
%opts and _croak_bad_options(keys %opts);
$overwrite = 1 unless (defined $overwrite or $numbered);
my $perm = (lstat $local)[2];
unless (defined $perm) {
$sftp->_set_error(SFTP_ERR_LOCAL_STAT_FAILED,
"Couldn't stat local file '$local'", $!);
return undef;
}
unless (_is_lnk($perm)) {
$sftp->_set_error(SFTP_ERR_LOCAL_BAD_OBJECT,
"Local file $local is not a symlink");
return undef;
}
my $target = readlink $local;
unless (defined $target) {
$sftp->_set_error(SFTP_ERR_LOCAL_READLINK_FAILED,
"Couldn't read link '$local'", $!);
return undef;
}
while (1) {
local $sftp->{_autodie};
$sftp->symlink($remote, $target);
if ($sftp->error and
$sftp->status == SSH2_FX_FAILURE) {
if ($numbered and $sftp->test_e($remote)) {
_inc_numbered($remote);
redo;
}
elsif ($overwrite and $sftp->_remove_save_status($remote)) {
$overwrite = 0;
redo;
}
}
last
}
$$numbered = $remote if ref $numbered;
$sftp->_ok_or_autodie;
}
sub rget {
@_ >= 2 or croak 'Usage: $sftp->rget($remote, $local, %opts)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $remote, $local, %opts) = @_;
defined $remote or croak "remote file path is undefined";
$local = File::Spec->curdir unless defined $local;
# my $cb = delete $opts{callback};
my $umask = delete $opts{umask};
my $copy_perm = delete $opts{exists $opts{copy_perm} ? 'copy_perm' : 'copy_perms'};
my $copy_time = delete $opts{copy_time};
my $newer_only = delete $opts{newer_only};
my $on_error = delete $opts{on_error};
local $sftp->{_autodie} if $on_error;
my $ignore_links = delete $opts{ignore_links};
# my $relative_links = delete $opts{relative_links};
my $wanted = _gen_wanted( delete $opts{wanted},
delete $opts{no_wanted} );
my %get_opts = (map { $_ => delete $opts{$_} }
qw(block_size queue_size overwrite conversion
resume numbered atomic));
if ($get_opts{resume} and $get_opts{conversion}) {
carp "resume option is useless when data conversion has also been requested";
delete $get_opts{resume};
}
my %get_symlink_opts = (map { $_ => $get_opts{$_} }
qw(overwrite numbered));
%opts and _croak_bad_options(keys %opts);
$remote = $sftp->join($remote, './');
my $qremote = quotemeta $remote;
my $reremote = qr/^$qremote(.*)$/i;
$umask = umask $umask if (defined $umask);
$copy_perm = 1 unless defined $copy_perm;
$copy_time = 1 unless defined $copy_time;
require File::Spec;
my $count = 0;
$sftp->find( [$remote],
descend => sub {
my $e = $_[1];
# print "descend: $e->{filename}\n";
if (!$wanted or $wanted->($sftp, $e)) {
my $fn = $e->{filename};
if ($fn =~ $reremote) {
my $lpath = File::Spec->catdir($local, $1);
($lpath) = $lpath =~ /(.*)/ if ${^TAINT};
if (-d $lpath) {
$sftp->_set_error(SFTP_ERR_LOCAL_ALREADY_EXISTS,
"directory '$lpath' already exists");
$sftp->_call_on_error($on_error, $e);
return 1;
}
else {
if (CORE::mkdir $lpath, ($copy_perm ? $e->{a}->perm & 0777 : 0777)) {
$count++;
return 1;
}
else {
$sftp->_set_error(SFTP_ERR_LOCAL_MKDIR_FAILED,
"mkdir '$lpath' failed", $!);
}
}
}
else {
$sftp->_set_error(SFTP_ERR_REMOTE_BAD_PATH,
"bad remote path '$fn'");
}
$sftp->_call_on_error($on_error, $e);
}
return undef;
},
wanted => sub {
my $e = $_[1];
# print "file fn:$e->{filename}, a:$e->{a}\n";
unless (_is_dir($e->{a}->perm)) {
if (!$wanted or $wanted->($sftp, $e)) {
my $fn = $e->{filename};
if ($fn =~ $reremote) {
my $lpath = File::Spec->catfile($local, $1);
($lpath) = $lpath =~ /(.*)/ if ${^TAINT};
if (_is_lnk($e->{a}->perm) and !$ignore_links) {
if ($sftp->get_symlink($fn, $lpath,
copy_time => $copy_time,
%get_symlink_opts)) {
$count++;
return undef;
}
}
elsif (_is_reg($e->{a}->perm)) {
if ($newer_only and -e $lpath
and (CORE::stat _)[9] >= $e->{a}->mtime) {
$sftp->_set_error(SFTP_ERR_LOCAL_ALREADY_EXISTS,
"newer local file '$lpath' already exists");
}
else {
if ($sftp->get($fn, $lpath,
copy_perm => $copy_perm,
copy_time => $copy_time,
%get_opts)) {
$count++;
return undef;
}
}
}
else {
$sftp->_set_error(SFTP_ERR_REMOTE_BAD_OBJECT,
( $ignore_links
? "remote file '$fn' is not regular file or directory"
: "remote file '$fn' is not regular file, directory or link"));
}
}
else {
$sftp->_set_error(SFTP_ERR_REMOTE_BAD_PATH,
"bad remote path '$fn'");
}
$sftp->_call_on_error($on_error, $e);
}
}
return undef;
} );
umask $umask if defined $umask;
return $count;
}
sub rput {
@_ >= 2 or croak 'Usage: $sftp->rput($local, $remote, %opts)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $local, $remote, %opts) = @_;
defined $local or croak "local path is undefined";
$remote = '.' unless defined $remote;
# my $cb = delete $opts{callback};
my $umask = delete $opts{umask};
my $copy_perm = delete $opts{exists $opts{copy_perm} ? 'copy_perm' : 'copy_perms'};
my $copy_time = delete $opts{copy_time};
my $newer_only = delete $opts{newer_only};
my $on_error = delete $opts{on_error};
local $sftp->{_autodie} if $on_error;
my $ignore_links = delete $opts{ignore_links};
my $wanted = _gen_wanted( delete $opts{wanted},
delete $opts{no_wanted} );
my %put_opts = (map { $_ => delete $opts{$_} }
qw(block_size queue_size overwrite conversion
resume numbered late_set_perm atomic));
my %put_symlink_opts = (map { $_ => $put_opts{$_} }
qw(overwrite numbered));
%opts and _croak_bad_options(keys %opts);
require Net::SFTP::Foreign::Local;
my $lfs = Net::SFTP::Foreign::Local->new;
$local = $lfs->join($local, './');
my $relocal;
if ($local =~ m|^\./?$|) {
$relocal = qr/^(.*)$/;
}
else {
my $qlocal = quotemeta $local;
$relocal = qr/^$qlocal(.*)$/i;
}
$copy_perm = 1 unless defined $copy_perm;
$copy_time = 1 unless defined $copy_time;
$umask = umask unless defined $umask;
my $mask = ~$umask;
if ($on_error) {
my $on_error1 = $on_error;
$on_error = sub {
my $lfs = shift;
$sftp->_copy_error($lfs);
$sftp->_call_on_error($on_error1, @_);
}
}
my $count = 0;
$lfs->find( [$local],
descend => sub {
my $e = $_[1];
# print "descend: $e->{filename}\n";
if (!$wanted or $wanted->($lfs, $e)) {
my $fn = $e->{filename};
$debug and $debug and 32768 and _debug "rput handling $fn";
if ($fn =~ $relocal) {
my $rpath = $sftp->join($remote, File::Spec->splitdir($1));
$debug and $debug and 32768 and _debug "rpath: $rpath";
if ($sftp->test_d($rpath)) {
$lfs->_set_error(SFTP_ERR_REMOTE_ALREADY_EXISTS,
"Remote directory '$rpath' already exists");
$lfs->_call_on_error($on_error, $e);
return 1;
}
else {
my $a = Net::SFTP::Foreign::Attributes->new;
$a->set_perm(($copy_perm ? $e->{a}->perm & 0777 : 0777) & $mask);
if ($sftp->mkdir($rpath, $a)) {
$count++;
return 1;
}
else {
$lfs->_copy_error($sftp);
}
}
}
else {
$lfs->_set_error(SFTP_ERR_LOCAL_BAD_PATH,
"Bad local path '$fn'");
}
$lfs->_call_on_error($on_error, $e);
}
return undef;
},
wanted => sub {
my $e = $_[1];
# print "file fn:$e->{filename}, a:$e->{a}\n";
unless (_is_dir($e->{a}->perm)) {
if (!$wanted or $wanted->($lfs, $e)) {
my $fn = $e->{filename};
$debug and $debug and 32768 and _debug "rput handling $fn";
if ($fn =~ $relocal) {
my (undef, $d, $f) = File::Spec->splitpath($1);
my $rpath = $sftp->join($remote, File::Spec->splitdir($d), $f);
if (_is_lnk($e->{a}->perm) and !$ignore_links) {
if ($sftp->put_symlink($fn, $rpath,
%put_symlink_opts)) {
$count++;
return undef;
}
$lfs->_copy_error($sftp);
}
elsif (_is_reg($e->{a}->perm)) {
my $ra;
if ( $newer_only and
$ra = $sftp->stat($rpath) and
$ra->mtime >= $e->{a}->mtime) {
$lfs->_set_error(SFTP_ERR_REMOTE_ALREADY_EXISTS,
"Newer remote file '$rpath' already exists");
}
else {
if ($sftp->put($fn, $rpath,
perm => ($copy_perm ? $e->{a}->perm : 0777) & $mask,
copy_time => $copy_time,
%put_opts)) {
$count++;
return undef;
}
$lfs->_copy_error($sftp);
}
}
else {
$lfs->_set_error(SFTP_ERR_LOCAL_BAD_OBJECT,
( $ignore_links
? "Local file '$fn' is not regular file or directory"
: "Local file '$fn' is not regular file, directory or link"));
}
}
else {
$lfs->_set_error(SFTP_ERR_LOCAL_BAD_PATH,
"Bad local path '$fn'");
}
$lfs->_call_on_error($on_error, $e);
}
}
return undef;
} );
return $count;
}
sub mget {
@_ >= 2 or croak 'Usage: $sftp->mget($remote, $localdir, %opts)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $remote, $localdir, %opts) = @_;
defined $remote or croak "remote pattern is undefined";
my $on_error = $opts{on_error};
local $sftp->{_autodie} if $on_error;
my $ignore_links = delete $opts{ignore_links};
my %glob_opts = (map { $_ => delete $opts{$_} }
qw(on_error follow_links ignore_case
wanted no_wanted strict_leading_dot));
my %get_symlink_opts = (map { $_ => $opts{$_} }
qw(overwrite numbered));
my %get_opts = (map { $_ => delete $opts{$_} }
qw(umask copy_perm copy_time block_size queue_size
overwrite conversion resume numbered atomic));
%opts and _croak_bad_options(keys %opts);
my @remote = map $sftp->glob($_, %glob_opts), _ensure_list $remote;
my $count = 0;
require File::Spec;
for my $e (@remote) {
my $perm = $e->{a}->perm;
if (_is_dir($perm)) {
$sftp->_set_error(SFTP_ERR_REMOTE_BAD_OBJECT,
"Remote object '$e->{filename}' is a directory");
}
else {
my $fn = $e->{filename};
my ($local) = $fn =~ m{([^\\/]*)$};
$local = File::Spec->catfile($localdir, $local)
if defined $localdir;
if (_is_lnk($perm)) {
next if $ignore_links;
$sftp->get_symlink($fn, $local, %get_symlink_opts);
}
else {
$sftp->get($fn, $local, %get_opts);
}
}
$count++ unless $sftp->error;
$sftp->_call_on_error($on_error, $e);
}
$count;
}
sub mput {
@_ >= 2 or croak 'Usage: $sftp->mput($local, $remotedir, %opts)';
my ($sftp, $local, $remotedir, %opts) = @_;
defined $local or die "local pattern is undefined";
my $on_error = $opts{on_error};
local $sftp->{_autodie} if $on_error;
my $ignore_links = delete $opts{ignore_links};
my %glob_opts = (map { $_ => delete $opts{$_} }
qw(on_error follow_links ignore_case
wanted no_wanted strict_leading_dot));
my %put_symlink_opts = (map { $_ => $opts{$_} }
qw(overwrite numbered));
my %put_opts = (map { $_ => delete $opts{$_} }
qw(umask copy_perm copy_time block_size queue_size
overwrite conversion resume numbered late_set_perm atomic));
%opts and _croak_bad_options(keys %opts);
require Net::SFTP::Foreign::Local;
my $lfs = Net::SFTP::Foreign::Local->new;
my @local = map $lfs->glob($_, %glob_opts), _ensure_list $local;
my $count = 0;
require File::Spec;
for my $e (@local) {
my $perm = $e->{a}->perm;
if (_is_dir($perm)) {
$sftp->_set_error(SFTP_ERR_REMOTE_BAD_OBJECT,
"Remote object '$e->{filename}' is a directory");
}
else {
my $fn = $e->{filename};
my $remote = (File::Spec->splitpath($fn))[2];
$remote = $sftp->join($remotedir, $remote)
if defined $remotedir;
if (_is_lnk($perm)) {
next if $ignore_links;
$sftp->put_symlink($fn, $remote, %put_symlink_opts);
}
else {
$sftp->put($fn, $remote, %put_opts);
}
}
$count++ unless $sftp->error;
$sftp->_call_on_error($on_error, $e);
}
$count;
}
sub _get_statvfs {
my ($sftp, $eid, $error, $errstr) = @_;
if (my $msg = $sftp->_get_msg_and_check(SSH2_FXP_EXTENDED_REPLY,
$eid, $error, $errstr)) {
# printf STDERR "msg length: %i\n", length $$msg;
my %statvfs = map { $_ => $msg->get_int64 } qw(bsize frsize blocks
bfree bavail files ffree
favail fsid flag namemax);
return \%statvfs;
}
return undef;
}
sub statvfs {
@_ == 2 or croak 'Usage: $sftp->statvfs($path)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $path) = @_;
$sftp->_check_extension('statvfs@openssh.com' => 2,
SFTP_ERR_REMOTE_STATVFS_FAILED,
"statvfs failed")
or return undef;
$path = $sftp->_rel2abs($path);
my $id = $sftp->_queue_new_msg(SSH2_FXP_EXTENDED,
str => 'statvfs@openssh.com',
str => $sftp->_fs_encode($path));
$sftp->_get_statvfs($id,
SFTP_ERR_REMOTE_STATVFS_FAILED,
"Couldn't stat remote file system");
}
sub fstatvfs {
@_ == 2 or croak 'Usage: $sftp->fstatvfs($fh)';
${^TAINT} and &_catch_tainted_args;
my ($sftp, $fh) = @_;
$sftp->_check_extension('fstatvfs@openssh.com' => 2,
SFTP_ERR_REMOTE_FSTATVFS_FAILED,
"fstatvfs failed")
or return undef;
my $rid = $sftp->_rid($fh);
my $id = $sftp->_queue_new_msg(SSH2_FXP_EXTENDED,
str => 'fstatvfs@openssh.com',
str => $rid);
$sftp->_get_statvfs($id,
SFTP_ERR_REMOTE_FSTATVFS_FAILED,
"Couldn't stat remote file system");
}
package Net::SFTP::Foreign::Handle;
use Tie::Handle;
our @ISA = qw(Tie::Handle);
our @CARP_NOT = qw(Net::SFTP::Foreign Tie::Handle);
my $gen_accessor = sub {
my $ix = shift;
sub {
my $st = *{shift()}{ARRAY};
if (@_) {
$st->[$ix] = shift;
}
else {
$st->[$ix]
}
}
};
my $gen_proxy_method = sub {
my $method = shift;
sub {
my $self = $_[0];
$self->_check
or return undef;
my $sftp = $self->_sftp;
if (wantarray) {
my @ret = $sftp->$method(@_);
$sftp->_set_errno unless @ret;
return @ret;
}
else {
my $ret = $sftp->$method(@_);
$sftp->_set_errno unless defined $ret;
return $ret;
}
}
};
my $gen_not_supported = sub {
sub {
$! = Errno::ENOTSUP();
undef
}
};
sub TIEHANDLE { return shift }
# sub UNTIE {}
sub _new_from_rid {
my $class = shift;
my $sftp = shift;
my $rid = shift;
my $flags = shift || 0;
my $self = Symbol::gensym;
bless $self, $class;
*$self = [ $sftp, $rid, 0, $flags, @_];
tie *$self, $self;
$self;
}
sub _close {
my $self = shift;
@{*{$self}{ARRAY}} = ();
}
sub _check {
return 1 if defined(*{shift()}{ARRAY}[0]);
$! = Errno::EBADF;
undef;
}
sub FILENO {
my $self = shift;
$self->_check
or return undef;
my $hrid = unpack 'H*' => $self->_rid;
"-1:sftp(0x$hrid)"
}
sub _sftp { *{shift()}{ARRAY}[0] }
sub _rid { *{shift()}{ARRAY}[1] }
* _pos = $gen_accessor->(2);
sub _inc_pos {
my ($self, $inc) = @_;
*{shift()}{ARRAY}[2] += $inc;
}
my %flag_bit = (append => 0x1);
sub _flag {
my $st = *{shift()}{ARRAY};
my $fn = shift;
my $flag = $flag_bit{$fn};
Carp::croak("unknown flag $fn") unless defined $flag;
if (@_) {
if (shift) {
$st->[3] |= $flag;
}
else {
$st->[3] &= ~$flag;
}
}
$st->[3] & $flag ? 1 : 0
}
sub _check_is_file {
Carp::croak("expecting remote file handler, got directory handler");
}
sub _check_is_dir {
Carp::croak("expecting remote directory handler, got file handler");
}
my $autoloaded;
sub AUTOLOAD {
my $self = shift;
our $AUTOLOAD;
if ($autoloaded) {
my $class = ref $self || $self;
Carp::croak qq|Can't locate object method "$AUTOLOAD" via package "$class|;
}
else {
$autoloaded = 1;
require IO::File;
require IO::Dir;
my ($method) = $AUTOLOAD =~ /^.*::(.*)$/;
$self->$method(@_);
}
}
package Net::SFTP::Foreign::FileHandle;
our @ISA = qw(Net::SFTP::Foreign::Handle IO::File);
sub _new_from_rid {
my $class = shift;
my $sftp = shift;
my $rid = shift;
my $flags = shift;
my $self = $class->SUPER::_new_from_rid($sftp, $rid, $flags, '', '');
}
sub _check_is_file {}
sub _bin { \(*{shift()}{ARRAY}[4]) }
sub _bout { \(*{shift()}{ARRAY}[5]) }
sub WRITE {
my ($self, undef, $length, $offset) = @_;
$self->_check
or return undef;
$offset = 0 unless defined $offset;
$offset = length $_[1] + $offset if $offset < 0;
$length = length $_[1] unless defined $length;
my $sftp = $self->_sftp;
my $ret = $sftp->write($self, substr($_[1], $offset, $length));
$sftp->_set_errno unless defined $ret;
$ret;
}
sub READ {
my ($self, undef, $len, $offset) = @_;
$self->_check
or return undef;
$_[1] = '' unless defined $_[1];
$offset ||= 0;
if ($offset > length $_[1]) {
$_[1] .= "\0" x ($offset - length $_[1])
}
if ($len == 0) {
substr($_[1], $offset) = '';
return 0;
}
my $sftp = $self->_sftp;
$sftp->_fill_read_cache($self, $len);
my $bin = $self->_bin;
if (length $$bin) {
my $data = substr($$bin, 0, $len, '');
$self->_inc_pos($len);
substr($_[1], $offset) = $data;
return length $data;
}
return 0 if $sftp->{_status} == $sftp->SSH2_FX_EOF;
$sftp->_set_errno;
undef;
}
sub EOF {
my $self = $_[0];
$self->_check or return undef;
my $sftp = $self->_sftp;
my $ret = $sftp->eof($self);
$sftp->_set_errno unless defined $ret;
$ret;
}
*GETC = $gen_proxy_method->('getc');
*TELL = $gen_proxy_method->('tell');
*SEEK = $gen_proxy_method->('seek');
*CLOSE = $gen_proxy_method->('close');
my $readline = $gen_proxy_method->('readline');
sub READLINE { $readline->($_[0], $/) }
sub OPEN {
shift->CLOSE;
undef;
}
sub DESTROY {
my $self = shift;
my $sftp = $self->_sftp;
$debug and $debug & 4 and Net::SFTP::Foreign::_debug("$self->DESTROY called (sftp: ".($sftp||'').")");
if ($self->_check and $sftp) {
local $sftp->{_autodie};
$sftp->_close_save_status($self)
}
}
package Net::SFTP::Foreign::DirHandle;
our @ISA = qw(Net::SFTP::Foreign::Handle IO::Dir);
sub _new_from_rid {
my $class = shift;
my $sftp = shift;
my $rid = shift;
my $flags = shift;
my $self = $class->SUPER::_new_from_rid($sftp, $rid, $flags, []);
}
sub _check_is_dir {}
sub _cache { *{shift()}{ARRAY}[4] }
*CLOSEDIR = $gen_proxy_method->('closedir');
*READDIR = $gen_proxy_method->('_readdir');
sub OPENDIR {
shift->CLOSEDIR;
undef;
}
*REWINDDIR = $gen_not_supported->();
*TELLDIR = $gen_not_supported->();
*SEEKDIR = $gen_not_supported->();
sub DESTROY {
my $self = shift;
my $sftp = $self->_sftp;
$debug and $debug & 4 and Net::SFTP::Foreign::_debug("$self->DESTROY called (sftp: ".($sftp||'').")");
if ($self->_check and $sftp) {
local $sftp->{_autodie};
$sftp->_closedir_save_status($self)
}
}
1;
__END__
=head1 NAME
Net::SFTP::Foreign - SSH File Transfer Protocol client
=head1 SYNOPSIS
use Net::SFTP::Foreign;
my $sftp = Net::SFTP::Foreign->new($host);
$sftp->die_on_error("Unable to establish SFTP connection");
$sftp->setcwd($path) or die "unable to change cwd: " . $sftp->error;
$sftp->get("foo", "bar") or die "get failed: " . $sftp->error;
$sftp->put("bar", "baz") or die "put failed: " . $sftp->error;
=head1 DESCRIPTION
SFTP stands for SSH File Transfer Protocol and is a method of
transferring files between machines over a secure, encrypted
connection (as opposed to regular FTP, which functions over an
insecure connection). The security in SFTP comes through its
integration with SSH, which provides an encrypted transport layer over
which the SFTP commands are executed.
Net::SFTP::Foreign is a Perl client for the SFTP version 3 as defined
in the SSH File Transfer Protocol IETF draft, which can be found at
L<http://www.openssh.org/txt/draft-ietf-secsh-filexfer-02.txt> (also
included on this package distribution, on the C<rfc> directory).
Net::SFTP::Foreign uses any compatible C<ssh> command installed on
the system (for instance, OpenSSH C<ssh>) to establish the secure
connection to the remote server.
A wrapper module L<Net::SFTP::Foreign::Compat> is also provided for
compatibility with L<Net::SFTP>.
=head2 Net::SFTP::Foreign Vs. Net::SFTP Vs. Net::SSH2::SFTP
Why should I prefer Net::SFTP::Foreign over L<Net::SFTP>?
Well, both modules have their pros and cons:
Net::SFTP::Foreign does not require a bunch of additional modules and
external libraries to work, just the OpenBSD SSH client (or any other
client compatible enough).
I trust OpenSSH SSH client more than L<Net::SSH::Perl>, there are lots
of paranoid people ensuring that OpenSSH doesn't have security
holes!!!
If you have an SSH infrastructure already deployed, by using the same
binary SSH client, Net::SFTP::Foreign ensures a seamless integration
within your environment (configuration files, keys, etc.).
Net::SFTP::Foreign is much faster transferring files, specially over
networks with high (relative) latency.
Net::SFTP::Foreign provides several high level methods not available
from Net::SFTP as for instance C<find>, C<glob>, C<rget>, C<rput>,
C<rremove>, C<mget>, C<mput>.
On the other hand, using the external command means an additional
proccess being launched and running, depending on your OS this could
eat more resources than the in process pure perl implementation
provided by L<Net::SSH::Perl>.
L<Net::SSH2> is a module wrapping libssh2, an SSH version 2 client
library written in C. It is a very active project that aims to replace
L<Net::SSH::Perl>. Unfortunately, libssh2 SFTP functionality
(available in Perl via L<Net::SSH2::SFTP>) is rather limited and its
performance very poor.
Later versions of Net::SFTP::Foreign can use L<Net::SSH2> as the
transport layer via the backend module
L<Net::SFTP::Foreign::Backend::Net_SSH2>.
=head2 Error handling
Most of the methods available from this package return undef on
failure and a true value or the requested data on
success. C<$sftp-E<gt>error> should be used to check for errors
explicitly after every method call. For instance:
$sftp = Net::SFTP::Foreign->new($host);
$sftp->error and die "unable to connect to remote host: " . $sftp->error;
Also, the L</die_on_error> method provides a handy shortcut for the last line:
$sftp = Net::SFTP::Foreign->new($host);
$sftp->die_on_error("unable to connect to remote host");
Alternatively, the C<autodie> mode that makes the module die when any
error is found can be activated from the constructor. For instance:
$sftp = Net::SFTP::Foreign->new($host, autodie => 1);
my $ls = $sftp->ls("/bar");
# dies as: "Couldn't open remote dir '/bar': No such file"
The C<autodie> mode will be disabled when an C<on_error> handler is
passed to methods accepting it:
my $sftp = Net::SFTP::Foreign->new($host, autodie => 1);
# prints "foo!" and does not die:
$sftp->find("/sdfjkalshfl", # nonexistent directory
on_error => sub { print "foo!\n" });
# dies:
$sftp->find("/sdfjkalshfl");
=head2 API
The methods available from this module are described below.
Don't forget to read also the FAQ and BUGS sections at the end of this
document!
=over 4
=item Net::SFTP::Foreign->new($host, %args)
=item Net::SFTP::Foreign->new(%args)
Opens a new SFTP connection with a remote host C<$host>, and returns a
Net::SFTP::Foreign object representing that open connection.
An explicit check for errors should be included always after the
constructor call:
my $sftp = Net::SFTP::Foreign->new(...);
$sftp->die_on_error("SSH connection failed");
The optional arguments accepted are as follows:
=over 4
=item host =E<gt> $hostname
remote host name
=item user =E<gt> $username
username to log in to the remote server. This should be your SSH
login, and can be empty, in which case the username is drawn from the
user executing the process.
=item port =E<gt> $portnumber
port number where the remote SSH server is listening
=item ssh1 =E<gt> 1
use old SSH1 approach for starting the remote SFTP server.
=item more =E<gt> [@more_ssh_args]
additional args passed to C<ssh> command.
For debugging purposes you can run C<ssh> in verbose mode passing it
the C<-v> option:
my $sftp = Net::SFTP::Foreign->new($host, more => '-v');
Note that this option expects a single command argument or a reference
to an array of arguments. For instance:
more => '-v' # right
more => ['-v'] # right
more => "-c $cipher" # wrong!!!
more => [-c => $cipher] # right
=item timeout =E<gt> $seconds
when this parameter is set, the connection is dropped if no data
arrives on the SSH socket for the given time while waiting for some
command to complete.
When the timeout expires, the current method is aborted and
the SFTP connection becomes invalid.
=item fs_encoding =E<gt> $encoding
Version 3 of the SFTP protocol (the one supported by this module)
knows nothing about the character encoding used on the remote
filesystem to represent file and directory names.
This option allows one to select the encoding used in the remote
machine. The default value is C<utf8>.
For instance:
$sftp = Net::SFTP::Foreign->new('user@host', fs_encoding => 'latin1');
will convert any path name passed to any method in this package to its
C<latin1> representation before sending it to the remote side.
Note that this option will not affect file contents in any way.
This feature is not supported in perl 5.6 due to incomplete Unicode
support in the interpreter.
=item key_path =E<gt> $filename
asks C<ssh> to use the key in the given file for authentication.
=item password =E<gt> $password
=item passphrase =E<gt> $passphrase
uses L<Expect> to handle password authentication or keys requiring a
passphrase.
Note that password authentication on Windows OSs only works when the
Cygwin port of Perl is used.
=item expect_log_user =E<gt> $bool
activates password/passphrase authentication interaction logging (see
C<Expect::log_user> method documentation).
=item ssh_cmd =E<gt> $sshcmd
=item ssh_cmd =E<gt> \@sshcmd
name of the external SSH client. By default C<ssh> is used.
For instance:
$sftp = Net::SFTP::Foreign->new($host, ssh_cmd => 'plink');
When an array reference is used, its elements are inserted at the
beginning of the system call. That allows, for instance, to connect to
the target host through some SSH proxy:
$sftp = Net::SFTP::Foreign->new($host,
ssh_cmd => qw(ssh -l user proxy.server ssh));
But note that the module will not handle password authentication for
those proxies.
=item ssh_cmd_interface =E<gt> 'plink' or 'ssh' or 'tectia'
declares the command line interface that the SSH client used to
connect to the remote host understands. Currently C<plink>, C<ssh> and
C<tectia> are supported.
This option would be rarely required as the module infers the
interface from the SSH command name.
=item transport =E<gt> $fh
=item transport =E<gt> [$in_fh, $out_fh]
=item transport =E<gt> [$in_fh, $out_fh, $pid]
allows one to use an already open pipe or socket as the transport for the
SFTP protocol.
It can be (ab)used to make this module work with password
authentication or with keys requiring a passphrase.
C<in_fh> is the file handler used to read data from the remote server,
C<out_fh> is the file handler used to write data.
On some systems, when using a pipe as the transport, closing it, does
not cause the process at the other side to exit. The additional
C<$pid> argument can be used to instruct this module to kill that
process if it doesn't exit by itself.
=item open2_cmd =E<gt> [@cmd]
=item open2_cmd =E<gt> $cmd;
allows one to completely redefine how C<ssh> is called. Its arguments are
passed to L<IPC::Open2::open2> to open a pipe to the remote
server.
=item stderr_fh =E<gt> $fh
redirects the output sent to stderr by the SSH subprocess to the given
file handle.
It can be used to suppress banners:
open my $ssherr, '>', '/dev/null' or die "unable to open /dev/null";
my $sftp = Net::SFTP::Foreign->new($host,
stderr_fh => $ssherr);
Or to send SSH stderr to a file in order to capture errors for later
analysis:
my $ssherr = File::Temp->new or die "File::Temp->new failed";
my $sftp = Net::SFTP::Foreign->new($hostname, more => ['-v'],
stderr_fh => $ssherr);
if ($sftp->error) {
print "sftp error: ".$sftp->error."\n";
seek($ssherr, 0, 0);
while (<$ssherr>) {
print "captured stderr: $_";
}
}
=item stderr_discard =E<gt> 1
redirects stderr to /dev/null
=item block_size =E<gt> $default_block_size
=item queue_size =E<gt> $default_queue_size
default C<block_size> and C<queue_size> used for read and write
operations (see the C<put> or C<get> documentation).
=item autoflush =E<gt> $bool
by default, and for performance reasons, write operations are cached,
and only when the write buffer becomes big enough is the data written to
the remote file. Setting this flag makes the write operations inmediate.
=item write_delay =E<gt> $bytes
This option determines how many bytes are buffered before the real
SFTP write operation is performed.
=item read_ahead =E<gt> $bytes
On read operations this option determines how many bytes to read in
advance so that later read operations can be fulfilled from the
buffer.
Using a high value will increase the performance of the module for a
sequential reads access pattern but degrade it for a short random
reads access pattern. It can also cause synchronization problems if
the file is concurrently modified by other parties (L</flush> can be
used to discard all the data inside the read buffer on demand).
The default value is set dynamically considering some runtime
parameters and given options, though it tends to favor the sequential
read access pattern.
=item autodisconnect =E<gt> $ad
by default, the SSH connection is closed from the DESTROY method when
the object goes out of scope. But on scripts that fork new processes,
that results on the SSH connection being closed by the first process
where the object goes out of scope, something undesirable.
This option allows one to work-around this issue to some extend.
The acceptable values for C<$ad> are:
=over 4
=item 0
Never try to disconnect this object when exiting from any process.
On most operating systems, the SSH process will exit when the last
process connected to it ends, but this is not guaranteed.
=item 1
Disconnect on exit from any process. This is the default.
=item 2
Disconnect on exit from the current process only.
=back
See also the disconnect and autodisconnect methods.
=item late_set_perm =E<gt> $bool
See the FAQ below.
=item dirty_cleanup =E<gt> $bool
Sets the C<dirty_cleanup> flag in a per object basis (see the BUGS
section).
=item backend => $backend
From version 1.57 Net::SFTP::Foreign supports plugable backends in
order to allow other ways to comunicate with the remote server in
addition to the default I<pipe-to-ssh-process>.
Custom backends may change the set of options supported by the C<new>
method.
=item autodie => $bool
Enables the autodie mode that will cause the module to die when any
error is found (a la L<autodie>).
=back
=item $sftp-E<gt>error
Returns the error code from the last executed command. The value
returned is similar to C<$!>, when used as a string it yields the
corresponding error string.
See L<Net::SFTP::Foreign::Constants> for a list of possible error
codes and how to import them on your scripts.
=item $sftp-E<gt>die_on_error($msg)
Convenience method:
$sftp->die_on_error("Something bad happened");
# is a shortcut for...
$sftp->error and die "Something bad happened: " . $sftp->error;
=item $sftp-E<gt>status
Returns the code from the last SSH2_FXP_STATUS response. It is also a
dualvar that yields the status string when used as a string.
Usually C<$sftp-E<gt>error> should be checked first to see if there was
any error and then C<$sftp-E<gt>status> to find out its low level cause.
=item $sftp-E<gt>cwd
Returns the remote current working directory.
When a relative remote path is passed to any of the methods on this
package, this directory is used to compose the absolute path.
=item $sftp-E<gt>setcwd($dir)
Changes the remote current working directory. The remote directory
should exist, otherwise the call fails.
Returns the new remote current working directory or undef on failure.
=item $sftp-E<gt>get($remote, $local, %options)
X<get>Copies remote file C<$remote> to local $local. By default file
attributes are also copied (permissions, atime and mtime). For
instance:
$sftp->get('/var/log/messages', /tmp/messages')
or die "file transfer failed: " . $sftp->error;
A file handle can also be used as the local target. In that case, the
remote file contents are retrieved and written to the given file
handle. Note also that the handle is not closed when the transmission
finish.
open F, '| gzip -c > /tmp/foo' or die ...;
$sftp->get("/etc/passwd", \*F)
or die "get failed: " . $sftp->error;
close F or die ...;
Accepted options (not all combinations are possible):
=over 4
=item copy_time =E<gt> $bool
determines if access and modification time attributes have to be
copied from remote file. Default is to copy them.
=item copy_perm =E<gt> $bool
determines if permision attributes have to be copied from remote
file. Default is to copy them after applying the local process umask.
=item umask =E<gt> $umask
allows one to select the umask to apply when setting the permissions of
the copied file. Default is to use the umask for the current process.
=item perm =E<gt> $perm
sets the permision mask of the file to be $perm, umask and remote
permissions are ignored.
=item resume =E<gt> 1 | 'auto'
resumes an interrupted transfer.
If the C<auto> value is given, the transfer will be resumed only when
the local file is newer than the remote one.
C<get> transfers can not be resumed when a data conversion is in
place.
=item append =E<gt> 1
appends the contents of the remote file at the end of the local one
instead of overwriting it. If the local file does not exist a new one
is created.
=item overwrite =E<gt> 0
setting this option to zero cancels the transfer when a local file of
the same name already exists.
=item numbered =E<gt> 1
modifies the local file name inserting a sequence number when required
in order to avoid overwriting local files.
For instance:
for (1..2) {
$sftp->get("data.txt", "data.txt", numbered => 1);
}
will copy the remote file as "data.txt" the first time and as
"data(1).txt" the second one.
If a scalar reference is passed as the numbered value, the final
target will be stored in the value pointed by the reference. For
instance:
my $target;
$sftp->get("data.txt", "data.txt", numbered => \$target);
say "file was saved as $target" unless $sftp->error
=item atomic =E<gt> 1
The remote file contents are transferred into a temporal file that
once the copy completes is renamed to the target destination.
If not-overwrite of remote files is also requested, an empty file may
appear at the target destination before the rename operation is
performed. This is due to limitations of some operating/file systems.
=item cleanup =E<gt> 1
If the transfer fails, remove the incomplete file.
This option is set to by default when there is not possible to resume
the transfer afterwards (i.e., when using `atomic` or `numbered`
options).
=item conversion =E<gt> $conversion
on the fly data conversion of the file contents can be performed with
this option. See L</On the fly data conversion> below.
=item callback =E<gt> $callback
C<$callback> is a reference to a subroutine that will be called after
every iteration of the download process.
The callback function will receive as arguments: the current
Net::SFTP::Foreign object; the data read from the remote file; the
offset from the beginning of the file in bytes; and the total size of
the file in bytes.
This mechanism can be used to provide status messages, download
progress meters, etc.:
sub callback {
my($sftp, $data, $offset, $size) = @_;
print "Read $offset / $size bytes\r";
}
The C<abort> method can be called from inside the callback to abort
the transfer:
sub callback {
my($sftp, $data, $offset, $size) = @_;
if (want_to_abort_transfer()) {
$sftp->abort("You wanted to abort the transfer");
}
}
The callback will be called one last time with an empty data argument
to indicate the end of the file transfer.
The size argument can change between different calls as data is
transferred (for instance, when on-the-fly data conversion is being
performed or when the size of the file can not be retrieved with the
C<stat> SFTP command before the data transfer starts).
=item block_size =E<gt> $bytes
size of the blocks the file is being split on for transfer.
Incrementing this value can improve performance but some servers limit
the maximum size.
=item queue_size =E<gt> $size
read and write requests are pipelined in order to maximize transfer
throughput. This option allows one to set the maximum number of requests
that can be concurrently waiting for a server response.
=back
=item $sftp-E<gt>get_content($remote)
Returns the content of the remote file.
=item $sftp-E<gt>get_symlink($remote, $local, %opts)
copies a symlink from the remote server to the local file system
The accepted options are C<overwrite> and C<numbered>. They have the
same effect as for the C<get> method.
=item $sftp-E<gt>put($local, $remote, %opts)
Uploads a file C<$local> from the local host to the remote host, and
saves it as C<$remote>. By default file attributes are also
copied. For instance:
$sftp->put("test.txt", "test.txt")
or die "put failed: " . $sftp->error;
A file handle can also be passed in the C<$local> argument. In that
case, data is read from there and stored in the remote file. UTF8 data
is not supported unless a custom converter callback is used to
transform it to bytes and the method will croak if it encounters any
data in perl internal UTF8 format. Note also that the handle is not
closed when the transmission finish.
Example:
binmode STDIN;
$sftp->put(\*STDIN, "stdin.dat") or die "put failed";
close STDIN;
This method accepts several options:
=over 4
=item copy_time =E<gt> $bool
determines if access and modification time attributes have to be
copied from remote file. Default is to copy them.
=item copy_perm =E<gt> $bool
determines if permision attributes have to be copied from remote
file. Default is to copy them after applying the local process umask.
=item umask =E<gt> $umask
allows one to select the umask to apply when setting the permissions of
the copied file. Default is to use the umask for the current process.
=item perm =E<gt> $perm
sets the permision mask of the file to be $perm, umask and local
permissions are ignored.
=item overwrite =E<gt> 0
by default C<put> will overwrite any pre-existent file with the same
name at the remote side. Setting this flag to zero will make the
method fail in that case.
=item numbered =E<gt> 1
when required, adds a sequence number to local file names in order to
avoid overwriting pre-existent files. Off by default.
=item append =E<gt> 1
appends the local file at the end of the remote file instead of
overwriting it. If the remote file does not exist a new one is
created. Off by default.
=item resume =E<gt> 1 | 'auto'
resumes an interrupted transfer.
If the C<auto> value is given, the transfer will be resumed only when
the remote file is newer than the local one.
=item atomic =E<gt> 1
The local file contents are transferred into a temporal file that
once the copy completes is renamed to the target destination.
This operation relies on the SSH server to perform an
overwriting/non-overwriting atomic rename operation free of race
conditions.
OpenSSH server does it correctly on top of Linux/UNIX native file
systems (i.e. ext[234], ffs or zfs) but has problems on file systems
not supporting hard links (i.e. FAT) or on operating systems with
broken POSIX semantics as Windows.
=item cleanup =E<gt> 1
If the transfer fails, attempts to remove the incomplete file.
Cleanup may fail if for example the SSH connection gets broken.
This option is set to by default when there is not possible to resume
the transfer afterwards (i.e., when using `atomic` or `numbered`
options).
=item conversion =E<gt> $conversion
on the fly data conversion of the file contents can be performed with
this option. See L</On the fly data conversion> below.
=item callback =E<gt> $callback
C<$callback> is a reference to a subrutine that will be called after
every iteration of the upload process.
The callback function will receive as arguments: the current
Net::SFTP::Foreign object; the data that is going to be written to the
remote file; the offset from the beginning of the file in bytes; and
the total size of the file in bytes.
The callback will be called one last time with an empty data argument
to indicate the end of the file transfer.
The size argument can change between calls as data is transferred (for
instance, when on the fly data conversion is being performed).
This mechanism can be used to provide status messages, download
progress meters, etc.
The C<abort> method can be called from inside the callback to abort
the transfer.
=item block_size =E<gt> $bytes
size of the blocks the file is being split on for transfer.
Incrementing this value can improve performance but some servers limit
its size and if this limit is overpassed the command will fail.
=item queue_size =E<gt> $size
read and write requests are pipelined in order to maximize transfer
throughput. This option allows one to set the maximum number of requests
that can be concurrently waiting for a server response.
=item late_set_perm =E<gt> $bool
See the FAQ below.
=back
=item $sftp-E<gt>put_symlink($local, $remote, %opts)
copies a local symlink to the remote host.
The accepted options are C<overwrite> and C<numbered>.
=item $sftp-E<gt>abort()
=item $sftp-E<gt>abort($msg)
This method, when called from inside a callback sub, causes the
current transfer to be aborted
The error state is set to SFTP_ERR_ABORTED and the optional $msg
argument is used as its textual value.
=item $sftp-E<gt>ls($remote, %opts)
Fetches a listing of the remote directory C<$remote>. If C<$remote> is
not given, the current remote working directory is listed.
Returns a reference to a list of entries. Every entry is a reference
to a hash with three keys: C<filename>, the name of the entry;
C<longname>, an entry in a "long" listing like C<ls -l>; and C<a>, a
L<Net::SFTP::Foreign::Attributes> object containing file atime, mtime,
permissions and size.
my $ls = $sftp->ls('/home/foo')
or die "unable to retrieve directory: ".$sftp->error;
print "$_->{filename}\n" for (@$ls);
The options accepted by this method are as follows (note that usage of
some of them can degrade the method performance when reading large
directories):
=over 4
=item wanted =E<gt> qr/.../
Only elements whose filename matchs the regular expression are included
on the listing.
=item wanted =E<gt> sub {...}
Only elements for which the callback returns a true value are included
on the listing. The callback is called with two arguments: the
C<$sftp> object and the current entry (a hash reference as described
before). For instance:
use Fcntl ':mode';
my $files = $sftp->ls ( '/home/hommer',
wanted => sub {
my $entry = $_[1];
S_ISREG($entry->{a}->perm)
} )
or die "ls failed: ".$sftp->error;
=item no_wanted =E<gt> qr/.../
=item no_wanted =E<gt> sub {...}
those options have the oposite result to their C<wanted> counterparts:
my $no_hidden = $sftp->ls( '/home/homer',
no_wanted => qr/^\./ )
or die "ls failed";
When both C<no_wanted> and C<wanted> rules are used, the C<no_wanted>
rule is applied first and then the C<wanted> one (order is important
if the callbacks have side effects, experiment!).
=item ordered =E<gt> 1
the list of entries is ordered by filename.
=item follow_links =E<gt> 1
by default, the attributes on the listing correspond to a C<lstat>
operation, setting this option causes the method to perform C<stat>
requests instead. C<lstat> attributes will stil appear for links
pointing to non existant places.
=item atomic_readdir =E<gt> 1
reading a directory is not an atomic SFTP operation and the protocol
draft does not define what happens if C<readdir> requests and write
operations (for instance C<remove> or C<open>) affecting the same
directory are intermixed.
This flag ensures that no callback call (C<wanted>, C<no_wanted>) is
performed in the middle of reading a directory and has to be set if
any of the callbacks can modify the file system.
=item realpath =E<gt> 1
for every file object, performs a realpath operation and populates the
C<realpath> entry.
=item names_only =E<gt> 1
makes the method return a simple array containing the file names from
the remote directory only. For instance, these two sentences are
equivalent:
my @ls1 = @{ $sftp->ls('.', names_only => 1) };
my @ls2 = map { $_->{filename} } @{$sftp->ls('.')};
=back
=item $sftp-E<gt>find($path, %opts)
=item $sftp-E<gt>find(\@paths, %opts)
X<find>Does a recursive search over the given directory C<$path> (or
directories C<@path>) and returns a list of the entries found or the
total number of them on scalar context.
Every entry is a reference to a hash with two keys: C<filename>, the
full path of the entry; and C<a>, a L<Net::SFTP::Foreign::Attributes>
object containing file atime, mtime, permissions and size.
This method tries to recover and continue under error conditions.
The options accepted:
=over 4
=item on_error =E<gt> sub { ... }
the callback is called when some error is detected, two arguments are
passed: the C<$sftp> object and the entry that was being processed
when the error happened. For instance:
my @find = $sftp->find( '/',
on_error => sub {
my ($sftp, $e) = @_;
print STDERR "error processing $e->{filename}: "
. $sftp->error;
} );
=item realpath =E<gt> 1
calls method C<realpath> for every entry, the result is stored under
the key C<realpath>. This option slows down the process as a new
remote query is performed for every entry, specially on networks with
high latency.
=item follow_links =E<gt> 1
By default symbolic links are not resolved and appear as that on the
final listing. This option causes then to be resolved and substituted
by the target file system object. Dangling links are ignored, though
they generate a call to the C<on_error> callback when stat'ing them
fails.
Following sym links can introduce loops on the search. Infinite loops
are detected and broken but files can still appear repeated on the
final listing under different names unless the option C<realpath> is
also actived.
=item ordered =E<gt> 1
By default, the file system is searched in an implementation dependent
order (actually optimized for low memory comsumption). If this option
is included, the file system is searched in a deep-first, sorted by
filename fashion.
=item wanted =E<gt> qr/.../
=item wanted =E<gt> sub { ... }
=item no_wanted =E<gt> qr/.../
=item no_wanted =E<gt> sub { ... }
These options have the same effect as on the C<ls> method, allowing to
filter out unwanted entries (note that filename keys contain B<full
paths> here).
The callbacks can also be used to perform some action instead of
creating the full listing of entries in memory (that could use huge
amounts of RAM for big file trees):
$sftp->find($src_dir,
wanted => sub {
my $fn = $_[1]->{filename}
print "$fn\n" if $fn =~ /\.p[ml]$/;
return undef # so it is discarded
});
=item descend =E<gt> qr/.../
=item descend =E<gt> sub { ... }
=item no_descend =E<gt> qr/.../
=item no_descend =E<gt> sub { ... }
These options, similar to the C<wanted> ones, allow to prune the
search, discarding full subdirectories. For instance:
use Fcntl ':mode';
my @files = $sftp->find( '.',
no_descend => qr/\.svn$/,
wanted => sub {
S_ISREG($_[1]->{a}->perm)
} );
C<descend> and C<wanted> rules are unrelated. A directory discarded by
a C<wanted> rule will still be recursively searched unless it is also
discarded on a C<descend> rule and vice-versa.
=item atomic_readdir =E<gt> 1
see C<ls> method documentation.
=item names_only =E<gt> 1
makes the method return a list with the names of the files only (see C<ls>
method documentation).
equivalent:
my $ls1 = $sftp->ls('.', names_only => 1);
=back
=item $sftp-E<gt>glob($pattern, %opts)
X<glob>performs a remote glob and returns the list of matching entries
in the same format as the L</find> method.
This method tries to recover and continue under error conditions.
The given pattern can be a Unix style pattern (see L<glob(7)>) or a
Regexp object (i.e C<qr/foo/>). In the later case, only files on the
current working directory will be matched against the Regexp.
Accepted options:
=over 4
=item ignore_case =E<gt> 1
by default the matching over the file system is carried out in a case
sensitive fashion, this flag changes it to be case insensitive.
This flag is ignored when a Regexp object is used as the pattern.
=item strict_leading_dot =E<gt> 0
by default, a dot character at the beginning of a file or directory
name is not matched by willcards (C<*> or C<?>). Setting this flags to
a false value changes this behaviour.
This flag is ignored when a Regexp object is used as the pattern.
=item follow_links =E<gt> 1
=item ordered =E<gt> 1
=item names_only =E<gt> 1
=item realpath =E<gt> 1
=item on_error =E<gt> sub { ... }
=item wanted =E<gt> ...
=item no_wanted =E<gt> ...
these options perform as on the C<ls> method.
=back
Some usage samples:
my $files = $sftp->glob("*/lib");
my $files = $sftp->glob("/var/log/dmesg.*.gz");
$sftp->set_cwd("/var/log");
my $files = $sftp->glob(qr/^dmesg\.[\d+]\.gz$/);
my $files = $sftp->glob("*/*.pdf", strict_leading_dot => 0);
=item $sftp-E<gt>rget($remote, $local, %opts)
Recursively copies the contents of remote directory C<$remote> to
local directory C<$local>. Returns the total number of elements
(files, dirs and symbolic links) successfully copied.
This method tries to recover and continue when some error happens.
The options accepted are:
=over 4
=item umask =E<gt> $umask
use umask C<$umask> to set permissions on the files and directories
created.
=item copy_perm =E<gt> $bool;
if set to a true value, file and directory permissions are copied to
the remote server (after applying the umask). On by default.
=item copy_time =E<gt> $bool;
if set to a true value, file atime and mtime are copied from the
remote server. By default it is on.
=item overwrite =E<gt> $bool
if set to a true value, when a local file with the same name
already exists it is overwritten. On by default.
=item numbered =E<gt> $bool
when required, adds a sequence number to local file names in order to
avoid overwriting pre-existent remote files. Off by default.
=item newer_only =E<gt> $bool
if set to a true value, when a local file with the same name
already exists it is overwritten only if the remote file is newer.
=item ignore_links =E<gt> $bool
if set to a true value, symbolic links are not copied.
=item on_error =E<gt> sub { ... }
the passed sub is called when some error happens. It is called with two
arguments, the C<$sftp> object and the entry causing the error.
=item wanted =E<gt> ...
=item no_wanted =E<gt> ...
This option allows one to select which files and directories have to be
copied. See also C<ls> method docs.
If a directory is discarded all of its contents are also discarded (as
it is not possible to copy child files without creating the directory
first!).
=item atomic =E<gt> 1
=item block_size =E<gt> $block_size
=item queue_size =E<gt> $queue_size
=item conversion =E<gt> $conversion
=item resume =E<gt> $resume
See C<get> method docs.
=back
=item $sftp-E<gt>rput($local, $remote, %opts)
Recursively copies the contents of local directory C<$local> to
remote directory C<$remote>.
This method tries to recover and continue when some error happens.
Accepted options are:
=over 4
=item umask =E<gt> $umask
use umask C<$umask> to set permissions on the files and directories
created.
=item copy_perm =E<gt> $bool;
if set to a true value, file and directory permissions are copied
to the remote server (after applying the umask). On by default.
=item copy_time =E<gt> $bool;
if set to a true value, file atime and mtime are copied to the
remote server. On by default.
=item overwrite =E<gt> $bool
if set to a true value, when a remote file with the same name already
exists it is overwritten. On by default.
=item newer_only =E<gt> $bool
if set to a true value, when a remote file with the same name already exists it is
overwritten only if the local file is newer.
=item ignore_links =E<gt> $bool
if set to a true value, symbolic links are not copied
=item on_error =E<gt> sub { ... }
the passed sub is called when some error happens. It is called with two
arguments, the C<$sftp> object and the entry causing the error.
=item wanted =E<gt> ...
=item no_wanted =E<gt> ...
This option allows one to select which files and directories have to be
copied. See also C<ls> method docs.
If a directory is discarded all of its contents are also discarded (as
it is not possible to copy child files without creating the directory
first!).
=item atomic =E<gt> 1
=item block_size =E<gt> $block_size
=item queue_size =E<gt> $queue_size
=item conversion =E<gt> $conversion
=item resume =E<gt> $resume
=item late_set_perm =E<gt> $bool
see C<put> method docs.
=back
=item $sftp-E<gt>rremove($dir, %opts)
=item $sftp-E<gt>rremove(\@dirs, %opts)
recursively remove directory $dir (or directories @dirs) and its
contents. Returns the number of elements successfully removed.
This method tries to recover and continue when some error happens.
The options accepted are:
=over 4
=item on_error =E<gt> sub { ... }
This callback is called when some error is occurs. The arguments
passed are the C<$sftp> object and the current entry (see C<ls> docs
for more information).
=item wanted =E<gt> ...
=item no_wanted =E<gt> ...
Allow to select which file system objects have to be deleted.
=back
=item $sftp-E<gt>mget($remote, $localdir, %opts)
=item $sftp-E<gt>mget(\@remote, $localdir, %opts)
X<mget>expands the wildcards on C<$remote> or C<@remote> and retrieves
all the matching files.
For instance:
$sftp->mget(['/etc/hostname.*', '/etc/init.d/*'], '/tmp');
The method accepts all the options valid for L</glob> and for L</get>
(except those that do not make sense :-)
C<$localdir> is optional and defaults to the process cwd.
Files are saved with the same name they have in the remote server
excluding the directory parts.
Note that name collisions are not detected. For instance:
$sftp->mget(["foo/file.txt", "bar/file.txt"], "/tmp")
will transfer the first file to "/tmp/file.txt" and later overwrite it
with the second one. The C<numbered> option can be used to avoid this
issue.
=item $sftp-E<gt>mput($local, $remotedir, %opts)
=item $sftp-E<gt>mput(\@local, $remotedir, %opts)
similar to L</mget> but works in the opposite direction transferring
files from the local side to the remote one.
=item $sftp-E<gt>join(@paths)
returns the given path fragments joined in one path (currently the
remote file system is expected to be Unix like).
=item $sftp-E<gt>open($path, $flags [, $attrs ])
Sends the C<SSH_FXP_OPEN> command to open a remote file C<$path>,
and returns an open handle on success. On failure returns
C<undef>.
The returned value is a tied handle (see L<Tie::Handle>) that can be
used to access the remote file both with the methods available from
this module and with perl built-ins. For instance:
# reading from the remote file
my $fh1 = $sftp->open("/etc/passwd")
or die $sftp->error;
while (<$fh1>) { ... }
# writing to the remote file
use Net::SFTP::Foreign::Constants qw(:flags);
my $fh2 = $sftp->open("/foo/bar", SSH2_FXF_WRITE|SSH2_FXF_CREAT)
or die $sftp->error;
print $fh2 "printing on the remote file\n";
$sftp->write($fh2, "writing more");
The C<$flags> bitmap determines how to open the remote file as defined
in the SFTP protocol draft (the following constants can be imported
from L<Net::SFTP::Foreign::Constants>):
=over 4
=item SSH2_FXF_READ
Open the file for reading. It is the default mode.
=item SSH2_FXF_WRITE
Open the file for writing. If both this and C<SSH2_FXF_READ> are
specified, the file is opened for both reading and writing.
=item SSH2_FXF_APPEND
Force all writes to append data at the end of the file.
As OpenSSH SFTP server implementation ignores this flag, the module
emulates it (I will appreciate receiving feedback about the
interoperation of this module with other server implementations when
this flag is used).
=item SSH2_FXF_CREAT
If this flag is specified, then a new file will be created if one does
not already exist.
=item SSH2_FXF_TRUNC
Forces an existing file with the same name to be truncated to zero
length when creating a file. C<SSH2_FXF_CREAT> must also be specified
if this flag is used.
=item SSH2_FXF_EXCL
Causes the request to fail if the named file already exists.
C<SSH2_FXF_CREAT> must also be specified if this flag is used.
=back
When creating a new remote file, C<$attrs> allows one to set its initial
attributes. C<$attrs> has to be an object of class
L<Net::SFTP::Foreign::Attributes>.
=item $sftp-E<gt>close($handle)
Closes the remote file handle C<$handle>.
Files are automatically closed on the handle C<DESTROY> method when
not done explicitelly.
Returns true on success and undef on failure.
=item $sftp-E<gt>read($handle, $length)
reads C<$length> bytes from an open file handle C<$handle>. On success
returns the data read from the remote file and undef on failure
(including EOF).
=item $sftp-E<gt>write($handle, $data)
writes C<$data> to the remote file C<$handle>. Returns the number of
bytes written or undef on failure.
=item $sftp-E<gt>readline($handle)
=item $sftp-E<gt>readline($handle, $sep)
in scalar context reads and returns the next line from the remote
file. In list context, it returns all the lines from the current
position to the end of the file.
By default "\n" is used as the separator between lines, but a
different one can be used passing it as the second method argument. If
the empty string is used, it returns all the data from the current
position to the end of the file as one line.
=item $sftp-E<gt>getc($handle)
returns the next character from the file.
=item $sftp-E<gt>seek($handle, $pos, $whence)
sets the current position for the remote file handle C<$handle>. If
C<$whence> is 0, the position is set relative to the beginning of the
file; if C<$whence> is 1, position is relative to current position and
if $<$whence> is 2, position is relative to the end of the file.
returns a trues value on success, undef on failure.
=item $sftp-E<gt>tell($fh)
returns the current position for the remote file handle C<$handle>.
=item $sftp-E<gt>eof($fh)
reports whether the remote file handler points at the end of the file.
=item $sftp-E<gt>flush($fh)
X<flush>writes to the remote file any pending data and discards the read
cache.
=item $sftp-E<gt>sftpread($handle, $offset, $length)
low level method that sends a SSH2_FXP_READ request to read from an
open file handle C<$handle>, C<$length> bytes starting at C<$offset>.
Returns the data read on success and undef on failure.
Some servers (for instance OpenSSH SFTP server) limit the size of the
read requests and so the length of data returned can be smaller than
requested.
=item $sftp-E<gt>sftpwrite($handle, $offset, $data)
low level method that sends a C<SSH_FXP_WRITE> request to write to an
open file handle C<$handle>, starting at C<$offset>, and where the
data to be written is in C<$data>.
Returns true on success and undef on failure.
=item $sftp-E<gt>opendir($path)
Sends a C<SSH_FXP_OPENDIR> command to open the remote directory
C<$path>, and returns an open handle on success (unfortunately,
current versions of perl does not support directory operations via
tied handles, so it is not possible to use the returned handle as a
native one).
On failure returns C<undef>.
=item $sftp-E<gt>closedir($handle)
closes the remote directory handle C<$handle>.
Directory handles are closed from their C<DESTROY> method when not
done explicitly.
Return true on success, undef on failure.
=item $sftp-E<gt>readdir($handle)
returns the next entry from the remote directory C<$handle> (or all
the remaining entries when called in list context).
The return values are a hash with three keys: C<filename>, C<longname> and
C<a>. The C<a> value contains a L<Net::SFTP::Foreign::Attributes>
object describing the entry.
Returns undef on error or when no more entries exist on the directory.
=item $sftp-E<gt>stat($path)
performs a C<stat> on the remote file C<$path> and returns a
L<Net::SFTP::Foreign::Attributes> object with the result values.
Returns undef on failure.
=item $sftp-E<gt>fstat($handle)
is similar to the previous method but its argument has to be a handle
to an already open remote file instead of a file name.
=item $sftp-E<gt>lstat($path)
is similar to C<stat> method but stats a symbolic link instead of the
file the symbolic links points to.
=item $sftp-E<gt>setstat($path, $attrs)
sets file attributes on remote file C<$path>.
Returns true on success and undef on failure.
=item $sftp-E<gt>fsetstat($handle, $attrs)
is similar to setstat but its first argument has to be an open remote
file handle instead of a file name.
=item $sftp-E<gt>remove($path)
Sends a C<SSH_FXP_REMOVE> command to remove the remote file
C<$path>. Returns a true value on success and undef on failure.
=item $sftp-E<gt>mkdir($path)
=item $sftp-E<gt>mkdir($path, $attrs)
Sends a C<SSH_FXP_MKDIR> command to create a remote directory C<$path>
whose attributes are initialized to C<$attrs> (a
L<Net::SFTP::Foreign::Attributes> object) if given.
Returns a true value on success and undef on failure.
=item $sftp-E<gt>mkpath($path)
=item $sftp-E<gt>mkpath($path, $attrs)
This method is similar to C<mkdir> but also creates any non-existant
parent directories recursively.
=item $sftp-E<gt>rmdir($path)
Sends a C<SSH_FXP_RMDIR> command to remove a remote directory
C<$path>. Returns a true value on success and undef on failure.
=item $sftp-E<gt>realpath($path)
Sends a C<SSH_FXP_REALPATH> command to canonicalise C<$path>
to an absolute path. This can be useful for turning paths
containing C<'..'> into absolute paths.
Returns the absolute path on success, C<undef> on failure.
=item $sftp-E<gt>rename($old, $new, %opts)
Sends a C<SSH_FXP_RENAME> command to rename C<$old> to C<$new>.
Returns a true value on success and undef on failure.
Accepted options are:
=over 4
=item overwrite => $bool
By default, the rename operation fails when a file C<$new> already
exists. When this options is set, any previous existant file is
deleted first (the C<atomic_rename> operation will be used if
available).
Note than under some conditions the target file could be deleted and
afterwards the rename operation fail.
=back
=item $sftp-E<gt>atomic_rename($old, $new)
Renames a file using the C<posix-rename@openssh.com> extension when
available.
Unlike the C<rename> method, it overwrites any previous C<$new> file.
=item $sftp-E<gt>readlink($path)
Sends a C<SSH_FXP_READLINK> command to read the path where the
simbolic link is pointing.
Returns the target path on success and undef on failure.
=item $sftp-E<gt>symlink($sl, $target)
Sends a C<SSH_FXP_SYMLINK> command to create a new symbolic link
C<$sl> pointing to C<$target>.
C<$target> is stored as-is, without any path expansion taken place on
it. Use C<realpath> to normalize it:
$sftp->symlink("foo.lnk" => $sftp->realpath("../bar"))
=item $sftp-E<gt>hardlink($hl, $target)
Creates a hardlink on the server.
This command requires support for the 'hardlink@openssh.com' extension
on the server (available in OpenSSH from version 5.7).
=item $sftp-E<gt>statvfs($path)
=item $sftp-E<gt>fstatvfs($fh)
On servers supporting C<statvfs@openssh.com> and
C<fstatvfs@openssh.com> extensions respectively, these methods return
a hash reference with information about the file system where the file
named C<$path> or the open file C<$fh> resides.
The hash entries are:
bsize => file system block size
frsize => fundamental fs block size
blocks => number of blocks (unit f_frsize)
bfree => free blocks in file system
bavail => free blocks for non-root
files => total file inodes
ffree => free file inodes
favail => free file inodes for to non-root
fsid => file system id
flag => bit mask of f_flag values
namemax => maximum filename length
The values of the f_flag bit mask are as follows:
SSH2_FXE_STATVFS_ST_RDONLY => read-only
SSH2_FXE_STATVFS_ST_NOSUID => no setuid
=item $sftp-E<gt>disconnect
Closes the SSH connection to the remote host. From this point the
object becomes mostly useless.
Usually, this method should not be called explicitly, but implicitly
from the DESTROY method when the object goes out of scope.
See also the documentation for the C<autodiscconnect> constructor
argument.
=item $sftp-E<gt>autodisconnect($ad)
Sets the C<autodisconnect> behaviour.
See also the documentation for the C<autodiscconnect> constructor
argument. The values accepted here are the same as there.
=back
=head2 On the fly data conversion
Some of the methods on this module allow to perform on the fly data
conversion via the C<conversion> option that accepts the following
values:
=over 4
=item conversion =E<gt> 'dos2unix'
Converts CR+LF line endings (as commonly used under MS-DOS) to LF
(Unix).
=item conversion =E<gt> 'unix2dos'
Converts LF line endings (Unix) to CR+LF (DOS).
=item conversion =E<gt> sub { CONVERT $_[0] }
When a callback is given, it is invoked repeatly as chunks of data
become available. It has to change C<$_[0]> in place in order to
perform the conversion.
Also, the subroutine is called one last time with and empty data
string to indicate that the transfer has finished, so that
intermediate buffers can be flushed.
Note that when writing conversion subroutines, special care has to be
taken to handle sequences crossing chunk borders.
=back
The data conversion is always performed before any other callback
subroutine is called.
See the Wikipedia entry on line endings
L<http://en.wikipedia.org/wiki/Newline> or the article Understanding
Newlines by Xavier Noria
(L<http://www.onlamp.com/pub/a/onlamp/2006/08/17/understanding-newlines.html>)
for details about the different conventions.
=head1 FAQ
=over 4
=item Closing the connection:
B<Q>: How do I close the connection to the remote server?
B<A>: let the C<$sftp> object go out of scope or just undefine it:
undef $sftp;
=item Using Net::SFTP::Foreign from a cron script:
B<Q>: I wrote a script for performing sftp file transfers that works
beautifully from the command line. However when I try to run the same
script from cron it fails with a broken pipe error:
open2: exec of ssh -l user some.location.com -s sftp
failed at Net/SFTP/Foreign.pm line 67
B<A>: C<ssh> is not on your cron PATH.
The remedy is either to add the location of the C<ssh> application to
your cron PATH or to use the C<ssh_cmd> option of the C<new> method to
hardcode the location of C<ssh> inside your script, for instance:
my $ssh = Net::SFTP::Foreign->new($host,
ssh_cmd => '/usr/local/ssh/bin/ssh');
=item C<more> constructor option expects an array reference:
B<Q>: I'm trying to pass in the private key file using the -i option,
but it keep saying it couldn't find the key. What I'm doing wrong?
B<A>: The C<more> argument on the constructor expects a single option
or a reference to an array of options. It will not split an string
containing several options.
Arguments to SSH options have to be also passed as different entries
on the array:
my $sftp = Net::SFTP::Foreign->new($host,
more => [qw(-i /home/foo/.ssh/id_dsa)]);
Note also that latest versions of Net::SFTP::Foreign support the
C<key_path> argument:
my $sftp = Net::SFTP::Foreign->new($host,
key_path => '/home/foo/.ssh/id_dsa');
=item Plink and password authentication
B<Q>: Why password authentication is not supported for the plink SSH
client?
B<A>: A bug in plink breaks it.
Newer versions of Net::SFTP::Foreign pass the password to C<plink>
using its C<-pw> option. As this feature is not completely secure a
warning is generated.
It can be silenced (though, don't do it without understanding why it
is there, please!) as follows:
no warnings 'Net::SFTP::Foreign';
my $sftp = Net::SFTP::Foreign->new('foo@bar',
ssh_cmd => 'plink',
password => $password);
$sftp->die_on_error;
=item Plink
B<Q>: What is C<plink>?
B<A>: Plink is a command line tool distributed with the
L<PuTTY|http://the.earth.li/~sgtatham/putty/> SSH client. Very popular
between MS Windows users, it is also available for Linux and other
Unixes now.
=item Put method fails
B<Q>: put fails with the following error:
Couldn't setstat remote file (fsetstat): The requested operation
cannot be performed because there is a file transfer in progress.
B<A>: Try passing the C<late_set_perm> option to the put method:
$sftp->put($local, $remote, late_set_perm => 1)
or die "unable to transfer file: " . $sftp->error;
Some servers do not support the C<fsetstat> method on open file
handles. Setting this flag allows one to delay that operation until the
file has been completely transferred and the remote file handle
closed.
Send me a bug report containing a dump of your $sftp object so I
can add code for your particular server software to activate the
work-around automatically.
=item Put method fails even with late_set_perm set
B<Q>: I added C<late_set_perm =E<gt> 1> to the put call, but we are still
receiving the error "Couldn't setstat remote file (setstat)".
B<A>: Some servers forbid the SFTP C<setstat> operation used by the
C<put> method for replicating the file permissions and timestamps on
the remote side.
As a work around you can just disable the feature:
$sftp->put($local_file, $remote_file,
copy_perms => 0, copy_time => 0);
=item Disable password authentication completely
B<Q>: When we try to open a session and the key either doesn't exist
or is invalid, the child SSH hangs waiting for a password to be
entered. Is there a way to make this fail back to the Perl program to
be handled?
B<A>: Disable anything but public key SSH authentication calling the
new method as follows:
$sftp = Net::SFTP::Foreign->new($host,
more => [qw(-o PreferredAuthentications=publickey)])
See L<ssh_config(5)> for the details.
=item Understanding C<$attr-E<gt>perm> bits
B<Q>: How can I know if a directory entry is a (directory|link|file|...)?
B<A>: Use the C<S_IS*> functions from L<Fcntl>. For instance:
use Fcntl qw(S_ISDIR);
my $ls = $sftp->ls or die $sftp->error;
for my $entry (@$ls) {
if (S_ISDIR($entry->{a}->perm)) {
print "$entry->{filename} is a directory\n";
}
}
=item Host key checking
B<Q>: Connecting to a remote server with password authentication fails
with the following error:
The authenticity of the target host can not be established,
connect from the command line first
B<A>: That probably means that the public key from the remote server
is not stored in the C<~/.ssh/known_hosts> file. Run an SSH Connection
from the command line as the same user as the script and answer C<yes>
when asked to confirm the key supplied.
Example:
$ ssh pluto /bin/true
The authenticity of host 'pluto (172.25.1.4)' can't be established.
RSA key fingerprint is 41:b1:a7:86:d2:a9:7b:b0:7f:a1:00:b7:26:51:76:52.
Are you sure you want to continue connecting (yes/no)? yes
Your SSH client may also support some flag to disable this check, but
doing it can ruin the security of the SSH protocol so I advise against
its usage.
Example:
# Warning: don't do that unless you fully understand
# its security implications!!!
$sftp = Net::SFTP::Foreign->new($host,
more => [-o => 'StrictHostKeyChecking no'],
...);
=back
=head1 BUGS
These are the currently known bugs:
=over 4
=item - Doesn't work on VMS:
The problem is related to L<IPC::Open3> not working on VMS. Patches
are welcome!
=item - Dirty cleanup:
On some operating systems, closing the pipes used to comunicate with
the slave SSH process does not terminate it and a work around has to
be applied. If you find that your scripts hung when the $sftp object
gets out of scope, try setting C<$Net::SFTP::Foreign::dirty_cleanup>
to a true value and also send me a report including the value of
C<$^O> on your machine and the OpenSSH version.
From version 0.90_18 upwards, a dirty cleanup is performed anyway when
the SSH process does not terminate by itself in 8 seconds or less.
=item - Reversed symlink arguments:
This package uses the non-conforming OpenSSH argument order for the
SSH_FXP_SYMLINK command that seems to be the de facto standard. When
interacting with SFTP servers that follow the SFTP specification, the
C<symlink> method will interpret its arguments in reverse order.
=item - IPC::Open3 bugs on Windows
On Windows the IPC::Open3 module is used to spawn the slave SSH
process. That module has several nasty bugs (related to STDIN, STDOUT
and STDERR being closed or not being assigned to file descriptors 0, 1
and 2 respectively) that will cause the connection to fail.
Specifically this is known to happen under mod_perl/mod_perl2.
=back
Also, the following features should be considered experimental:
- support for Tectia server
- numbered feature
- autodie mode
=head1 SUPPORT
To report bugs, send me and email or use the CPAN bug tracking system
at L<http://rt.cpan.org>.
=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're 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 SEE ALSO
Information about the constants used on this module is available from
L<Net::SFTP::Foreign::Constants>. Information about attribute objects
is available from L<Net::SFTP::Foreign::Attributes>.
General information about SSH and the OpenSSH implementation is
available from the OpenSSH web site at L<http://www.openssh.org/> and
from the L<sftp(1)> and L<sftp-server(8)> manual pages.
Net::SFTP::Foreign integrates nicely with my other module
L<Net::OpenSSH>.
L<Net::SFTP::Foreign::Backend::Net_SSH2> allows one to run
Net::SFTP::Foreign on top of L<Net::SSH2> (nowadays, this combination
is probably the best option under Windows).
Modules offering similar functionality available from CPAN are
L<Net::SFTP> and L<Net::SSH2>.
L<Test::SFTP> allows one to run tests against a remote SFTP server.
L<autodie>.
=head1 COPYRIGHT
Copyright (c) 2005-2011 Salvador FandiE<ntilde>o (sfandino@yahoo.com).
Copyright (c) 2001 Benjamin Trott, Copyright (c) 2003 David Rolsky.
_glob_to_regex method based on code (c) 2002 Richard Clamp.
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included
with this module.
=cut
|