1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485
|
#!/usr/bin/perl
###########################################################################
#
# kpcli - KeePass Command Line Interface
#
# Author: Lester Hightower <hightowe at cpan dot org>
#
# This program was inspired by "kedpm -c" and resulted despite illness
# (or more likely because of it) over the USA Thanksgiving holiday in
# late November of 2010. As a long-time user of the Ked Password Manager
# I really missed a command line interface after getting an Android cell
# phone and switching to KeePass, so that I could access my password
# database on my phone. This program scratches that itch.
#
###########################################################################
# The required perl modules
use strict; # core
use version; # core
use File::Spec; # core
use FileHandle; # core
use Getopt::Long; # core
use File::Basename; # core
use Digest::file; # core
use Digest::MD5; # core
use Digest::SHA qw(sha256); # core
use Data::Dumper qw(Dumper); # core
use Term::ANSIColor; # core
use Carp qw(longmess); # core
use English qw(-no_match_vars); # core
use Time::HiRes qw(gettimeofday tv_interval); # core
use Time::Local qw(timegm); # core
use Clone qw(clone); # core
use Time::Piece; # core
use Time::Seconds; # core
use POSIX; # core, required for unsafe signal handling
use Crypt::Rijndael; # non-core, libcrypt-rijndael-perl on Ubuntu
use Sort::Naturally; # non-core, libsort-naturally-perl on Ubuntu
use Term::ReadKey; # non-core, libterm-readkey-perl on Ubuntu
use Term::ShellUI; # non-core, libterm-shellui-perl on Ubuntu
use File::KeePass 0.03; # non-core, libfile-keepass-perl on Ubuntu
# - >=v0.03 needed due critical bug fixes
# A developer convenience to force using a particular Term::ReadLine module
our $FORCED_READLINE = undef; # Auto-select
#our $FORCED_READLINE = 'Term::ReadLine::Gnu';
#our $FORCED_READLINE = 'Term::ReadLine::Perl';
#our $FORCED_READLINE = 'Term::ReadLine::Perl5';
# Pull in optional perl modules with run-time loading
my %OPTIONAL_PM=();
# Capture::Tiny is needed to safely optionally-load Clipboard.
# Clipboard is needed by the clipboard copy commands (xw, xu, xp, and xx).
if (runtime_load_module(\%OPTIONAL_PM,'Capture::Tiny',[qw(capture)])) {
# Clipboard tests its dependencies at import() and writes warnings to STDERR.
# Tiny::Capture is used to catch those warnings and we silently hold them
# until and unless someone tries to use dependant functions.
my ($out, $err, @result) = capture(
sub { runtime_load_module(\%OPTIONAL_PM,'Clipboard',undef); } );
if (length($err)) {
# Cleanup the error message for for better viewing by the user
$err =~ s/^\s+//g; $err =~ s/\s+$//g; $err =~ s/^(.*)$/ > $1/mg;
$OPTIONAL_PM{'Clipboard'}->{error} = $err;
}
} else {
# If we didn't get Capture::Tiny, also mark Clipboard as not loaded.
$OPTIONAL_PM{'Clipboard'}->{loaded} = 0;
}
# Win32::Console::ANSI is needed to emulate ANSI colors on Windows
if (lc($OSNAME) =~ m/^mswin/) {
if (! runtime_load_module(\%OPTIONAL_PM,'Win32::Console::ANSI',undef)) {
# If we don't have Win32::Console::ANSI then we want to override
# &main::color() and colored() from Term::ANSIColor with NOOPs.
no strict 'refs';
*color = sub { my $color = shift @_; return ''; };
*colored = sub { my $color = shift @_; my $text=shift @_; return $text; };
}
}
runtime_load_module(\%OPTIONAL_PM,'Sub::Install',undef);
# Optionally use a more cryptographically secure RNG.
our $RNG_EXT = undef;
if (runtime_load_module(\%OPTIONAL_PM,'Math::Random::ISAAC',undef)) {
$RNG_EXT = Math::Random::ISAAC->new(
int(1000000000 * (Time::HiRes::time() - int(Time::HiRes::time()))));
}
use subs 'rand'; # Override built-in rand() with our own function
sub rand {
my $ceiling = shift @_ || 1;
our $RNG_EXT;
if (defined($RNG_EXT) && ref($RNG_EXT) eq 'Math::Random::ISAAC') {
my $random = $RNG_EXT->rand() * $ceiling;
return $random;
}
return CORE::rand($ceiling);
}
$|=1; # flush immediately after writes or prints to STDOUT
my $DEBUG=0;
$Data::Dumper::Useqq = 1; # Have Dumper escape special chars (like \0)
my $DEFAULT_PASSWD_LEN = 20; # Default length of generated passwords.
my $DEFAULT_PASSWD_MIN = 1; # Minimum length of generated passwords.
my $DEFAULT_PASSWD_MAX = 50; # Maximum length of generated passwords.
my $DEFAULT_ENTRY_ICON = 0; # In keepassx, icon 0 is a golden key
my $DEfAULT_GROUP_ICON = 49; # In keepassx, icon 49 is an opened file folder
my $DEfAULT_BAKUP_ICON = 2; # In keepassx, icon 2 is a warning sign
my $FOUND_DIR = '_found'; # The find command's results go in /_found/
my $MAX_ATTACH_SIZE = 2*1024**2; # Maximum size of entry file attachments
# Application name and version
my $APP_NAME = basename($0); $APP_NAME =~ s/\.(pl|exe)$//;
my $VERSION = "3.1";
our $HISTORY_FILE = ""; # Gets set in the MyGetOpts() function
my $opts=MyGetOpts(); # Will only return with options we think we can use
my $doc_passwd_gen =
"For password generation, the \"g\" method produces a\n" .
"string of random characters, the \"w\" method creates a\n" .
"4-word string inspired by \"correct horse battery staple\"\n" .
"(http://xkcd.com/936/), and the \"i\" method provides an\n" .
"interactive user interface to the \"g\" and \"w\" methods.\n" .
"\n" .
"By default, the \"g\" and \"i\" methods generate passwords that\n" .
"are $DEFAULT_PASSWD_LEN characters long. " .
"That can be controlled by providing an\n" .
"integer immediately after the \"g|i\" in the range of "
. "$DEFAULT_PASSWD_MIN-$DEFAULT_PASSWD_MAX.\n" .
"For example, \"g17\" will generate a 17 character password.\n" .
"";
# Setup our Term::ShellUI object
my $term = new Term::ShellUI(
app => $APP_NAME,
term => get_readline_term(\%OPTIONAL_PM, $APP_NAME),
history_file => $HISTORY_FILE,
keep_quotes => 0,
commands => {
"ver" => {
desc => "Print the version of this program",
doc => "\n" .
"Add the -v option to get an inventory of the versions\n" .
"of the various dependencies being used. Please provide\n" .
"that information in any bug reports filed.\n" .
"",
method => \&cli_version,
minargs => 0, maxargs => 1,
exclude_from_history => 1,
timeout_exempt => 1,
},
"version" => { alias => "ver",
exclude_from_completion=>1, exclude_from_history => 1,
timeout_exempt => 1,
},
"vers" => {
desc => "Same as \"ver -v\"",
minargs => 0, maxargs => 0,
method => sub { cli_version(shift, { args => ['-v'] }); },
exclude_from_completion=>1, exclude_from_history => 1,
timeout_exempt => 1,
},
"versions" => { alias => "vers",
exclude_from_completion=>1, exclude_from_history => 1,
timeout_exempt => 1,
},
"help" => {
desc => "Print helpful information",
args => sub { shift->help_args(undef, @_); },
method => sub { my_help_call(@_); },
exclude_from_history => 1,
timeout_exempt => 1,
#method => sub { shift->help_call(undef, @_); }
},
"h" => { alias => "help",
exclude_from_completion=>1, exclude_from_history => 1,
timeout_exempt => 1,
},
"?" => { alias => "help",
exclude_from_completion=>1, exclude_from_history => 1,
timeout_exempt => 1,
},
"cls" => {
desc => 'Clear screen ("clear" command also works)',
doc => "\n" .
"Clear the screen, which is useful when guests arrive.\n",
maxargs => 0,
method => \&cli_cls,
exclude_from_history => 1,
timeout_exempt => 1,
},
"clear" => { alias => "cls", exclude_from_history => 1,
timeout_exempt => 1, },
"quit" => {
desc => "Quit this program (EOF and exit also work)",
maxargs => 0,
method => sub { run_no_TSTP(\&cli_quit, @_); },
exclude_from_history => 1,
timeout_exempt => 1,
},
"exit" => { alias => "quit", exclude_from_history => 1,
timeout_exempt => 1, },
# Generally, commands above here are timeout_exempt
#"" => { args => sub { shift->complete_history(@_) } },
"history" => { desc => "Prints the command history",
doc => "\nSpecify a number to list the last N lines of history.\n" .
"Pass -c to clear the command history.\n" .
"Pass -d NUM to delete a single item.\n",
args => "[-c] [-d] [number]",
method => sub { shift->history_call(@_) },
exclude_from_history => 1,
},
"cd" => {
desc => "Change directory (path to a group)",
doc => "\n" .
"Change the pwd to an absolute or relative path.\n" .
"Slashes in names are escaped with backslashes:\n" .
"(i.e. \"cd /personal/Comcast\\/Xfinity\").\n",
maxargs => 1,
args => \&complete_groups,
method => \&cli_cd,
},
"chdir" => { alias => 'cd' },
"cl" => {
desc => "Change directory and list entries (cd+ls)",
doc => "\n" .
"Change the pwd to an absolute or relative path\n" .
"and list the entries there. This is a useful way\n" .
"to quickly navigate to a path and have the entries\n" .
"listed in preparation to run the show command.\n",
maxargs => 1,
args => \&complete_groups,
method => sub { if(cli_cd(@_) == 0) { cli_ls() } },
},
"saveas" => {
desc => "Save to a specific filename " .
"(saveas <file.kdb> [<file.key>])",
minargs => 1, maxargs => 2,
args => [\&Term::ShellUI::complete_onlyfiles,
\&Term::ShellUI::complete_onlyfiles],
proc => sub { run_no_TSTP(\&cli_saveas, @_); },
},
"export" => {
desc => "Export entries to a new KeePass DB " .
"(export <file.kdb> [<file.key>])",
doc => "\n" .
"Use this command to export the full tree of groups\n" .
"and entries to another KeePass database file on disk,\n" .
"starting at your current path (pwd).\n" .
"\n" .
"This is also a \"safer\" way to change your database\n" .
"password. Export from /, verify that the new file is\n" .
"good, and then remove your original file.\n",
minargs => 1, maxargs => 2,
args => [\&Term::ShellUI::complete_onlyfiles,
\&Term::ShellUI::complete_onlyfiles],
proc => sub { run_no_TSTP(\&cli_export, @_); },
},
"import" => {
desc => "Import a password database " .
"(import <file> <path> [<file.key>])",
doc => "\n" .
"Use this command to import an entire password DB\n" .
"specified by <file> into a new group at <path>.\n" .
"Supported file types are KeePass v1 and v2, and\n" .
"Password Safe v3 (https://pwsafe.org/).\n",
minargs => 2, maxargs => 3,
args => [\&Term::ShellUI::complete_onlyfiles,\&complete_groups,
\&Term::ShellUI::complete_onlyfiles],
proc => sub { run_no_TSTP(\&cli_import, @_); },
},
"open" => {
desc => "Open a KeePass database file " .
"(open <file.kdb> [<file.key>])",
minargs => 1, maxargs => 2,
args => [\&Term::ShellUI::complete_onlyfiles,
\&Term::ShellUI::complete_onlyfiles],
proc => sub { run_no_TSTP(\&cli_open, @_); },
},
"mkdir" => {
desc => "Create a new group (mkdir <group_name>)",
minargs => 1, maxargs => 1,
args => \&complete_groups,
method => \&cli_mkdir,
},
"rmdir" => {
desc => "Delete a group (rmdir <group_name>)",
minargs => 1, maxargs => 1,
args => \&complete_groups,
method => \&cli_rmdir,
},
"dir" => { alias => "ls", },
"ls" => {
desc => "Lists items in the pwd or specified paths " .
"(\"dir\" also works)",
minargs => 0, maxargs => 99,
args => \&complete_groups_and_entries,
method => \&cli_ls,
},
"new" => {
desc => "Create a new entry: new <optional path&|title>",
doc => "\n" .
"The new command is used to create a new entry.\n" .
"\n" .
"Usage is straightforward.\n" .
"\n" .
$doc_passwd_gen .
"",
minargs => 0, maxargs => 1,
args => [\&complete_groups],
method => sub { run_no_TSTP(\&cli_new, @_); },
},
"rm" => {
desc => "Remove an entry: rm <path to entry|entry number>",
minargs => 1, maxargs => 1,
args => \&complete_groups_and_entries,
method => \&cli_rm,
},
"xu" => {
desc => "Copy username to clipboard: xu <entry path|number>",
minargs => 1, maxargs => 1,
args => \&complete_groups_and_entries,
method => sub { cli_xN('xu', @_); }
},
"xw" => {
desc => "Copy URL (www) to clipboard: xw <entry path|number>",
minargs => 1, maxargs => 1,
args => \&complete_groups_and_entries,
method => sub { cli_xN('xw', @_); }
},
"xp" => {
desc => "Copy password to clipboard: xp <entry path|number>",
minargs => 1, maxargs => 1,
args => \&complete_groups_and_entries,
method => sub { cli_xN('xp', @_); }
},
"xx" => {
desc => "Clear the clipboard: xx",
minargs => 0, maxargs => 0,
method => sub { cli_xN('xx'); }
},
"pwck" => {
desc => "Check password quality: pwck <entry|group>",
doc => "\n" .
"The pwck command test password quality for entries.\n" .
"You can check an individual entry or all entries inside\n" .
"of a group, recursively. To check every password in your\n" .
"database, use: pwck /\n" .
"",
minargs => 1, maxargs => 1,
args => \&complete_groups_and_entries,
method => \&cli_pwck,
},
"stats" => {
desc => "Prints statistics about the open KeePass file",
method => \&cli_stats,
},
"show" => {
desc => "Show an entry: show [-f] [-a] <entry path|entry number>",
doc => "\n" .
"The show command tries to intelligently determine\n" .
"what you want to see and to make it easy to display.\n" .
"Show can take a path to an entry as its argument or\n" .
"an entry number as shown by the ls command.\n" .
"\n" .
"When using entry numbers, they will refer to the last\n" .
"path when an ls was performed or pwd if ls has not\n" .
"yet been run.\n" .
"\n" .
"By default, passwords are \"hidden\" by being displayed as\n" .
"\"red on red\" where they can be copied to the clip board\n" .
"but not seen. Provide the -f option to show passwords.\n" .
"Use the -a option to see create and modified times, and\n" .
"the index of the icon set for the entry.\n" .
"",
minargs => 1, maxargs => 3,
args => \&complete_groups_and_entries,
method => \&cli_show,
},
"edit" => {
desc => "Edit an entry: edit <path to entry|entry number>",
doc => "\n" .
"The edit command is used to modify an entry.\n" .
"\n" .
"Usage is straightforward.\n" .
"\n" .
$doc_passwd_gen .
"",
minargs => 1, maxargs => 1,
args => \&complete_groups_and_entries,
method => sub { run_no_TSTP(\&cli_edit, @_); },
},
"attach" => {
desc => "Manage attachments: attach <path to entry|entry number>",
doc => "\n" .
"The attach command provided an interactive user interface\n" .
"for managing file attachments on an entry.\n" .
"",
minargs => 1, maxargs => 1,
args => \&complete_groups_and_entries,
method => sub { run_no_TSTP(\&cli_attach, @_); },
},
"mv" => {
desc => "Move an item: mv <path to a group|or entries> <path to group>",
minargs => 2, maxargs => 2,
args => [\&complete_groups_and_entries, \&complete_groups],
method => \&cli_mv,
},
"rename" => {
desc => "Rename a group: rename <path to group>",
minargs => 1, maxargs => 1,
args => \&complete_groups,
method => \&cli_rename,
},
"copy" => {
desc => "Copy an entry: copy <path to entry> <path to new entry>",
minargs => 2, maxargs => 2,
args => [\&complete_groups_and_entries,
\&complete_groups_and_entries],
method => \&cli_copy,
},
"cp" => { alias => "copy", },
"clone" => {
desc =>"Clone an entry: clone <path to entry> <path to new entry>",
doc => "\n" .
"Clones an entry for you to edit. Similar to doing\n" .
"\"cp foo bar; edit bar\" if that were possible.\n" .
"\n",
minargs => 2, maxargs => 2,
args => [\&complete_groups_and_entries,
\&complete_groups_and_entries],
method => sub { run_no_TSTP(\&cli_clone, @_); },
},
"save" => {
desc => "Save the database to disk",
minargs => 0, maxargs => 0, args => "",
method => sub { run_no_TSTP(\&cli_save, @_); },
},
"close" => {
desc => "Close the currently opened database",
minargs => 0, maxargs => 0, args => "",
method => sub { run_no_TSTP(\&cli_close, @_); },
},
"find" => {
desc => "Finds entries by Title",
doc => "\n" .
"Searches for entries with the given search term\n" .
"in their title and places matches into \"/$FOUND_DIR/\".\n" .
"\n" .
"Add -a to search data fields beyond just the title.\n" .
"\n" .
"Use -expired to find expired entries.\n",
minargs => 1, maxargs => 2, args => "<search string>",
method => \&cli_find,
},
"purge" => {
desc => "Purges entries in a given group base on criteria.",
doc => "\n" .
"Purges entries within a given group based on the age of\n" .
"the created, accessed, modified, or expiration fields.\n" .
"\n" .
"Add -r to recurse subgroups.\n" .
"\n" .
"Add --no-recycle to not copy purged entries to the\n" .
"/Backup or \"/Recycle Bin\" groups.\n",
minargs => 1, maxargs => 3, args => \&complete_groups_and_entries,
method => \&cli_purge,
},
"pwd" => {
desc => "Print the current working directory",
maxargs => 0, proc => \&cli_pwd,
},
"icons" => {
desc => "Change group or entry icons in the database",
maxargs => 0,
proc => sub { run_no_TSTP(\&cli_icons, @_); },
},
},
);
$term->prompt(\&term_set_prompt);
# Seed our state global variable
our $state={
'appname' => $APP_NAME,
'term' => $term,
'OPTIONAL_PM' => \%OPTIONAL_PM,
'kdb_has_changed' => 0,
'last_ls_ents' => [], # Array of entries last listed to the user.
'put_master_passwd' => \&put_master_passwd,
'get_master_passwd' => \&get_master_passwd,
'last_activity_time' => 0, # initilized by setup_timeout_handling()
};
# If given --kdb=, open that file
if (length($opts->{kdb})) {
my $err = open_kdb($opts->{kdb}, $opts->{key}); # Sets $state->{'kdb'}
if (length($err)) {
print "Error opening file: $err\n";
}
} else {
new_kdb($state);
}
# Enter the interative kpcli shell session
if (! defined($opts->{command})) {
print "\n" .
"KeePass CLI ($APP_NAME) v$VERSION is ready for operation.\n" .
"Type 'help' for a description of available commands.\n" .
"Type 'help <command>' for details on individual commands.\n";
}
if ($DEBUG) {print 'Using '.$term->{term}->ReadLine." for readline.\n"; }
if ( (! $DEBUG) && (lc($OSNAME) !~ m/^mswin/) &&
($term->{term}->ReadLine ne 'Term::ReadLine::Gnu')) {
print color('yellow') . "\n" .
"* NOTE: You are using " . $term->{term}->ReadLine . ".\n" .
" Term::ReadLine::Gnu will provide better functionality.\n" .
color('clear');
}
# My patch made it into Term::ShellUI v0.9, but I still chose not to make
# this program demand >=0.9 and instead look for the add_eof_exit_hook()
# and use it if it exists and warn if not.
if (Term::ShellUI->can('add_eof_exit_hook')) {
$term->add_eof_exit_hook(\&eof_exit_hook);
} else {
warn "* Please upgrade Term::ShellUI to version 0.9 or newer.\n";
}
print "\n";
setup_signal_handling(); # Exactly what the name indicates...
# Setup the inactivity timeout feature (--timeout).
if (defined($opts->{timeout}) && int($opts->{timeout}) > 0) {
if (! $state->{OPTIONAL_PM}->{'Sub::Install'}->{loaded}) {
print "Error: --timeout requires the Sub::Install module.\n";
exit;
}
setup_timeout_handling();
}
if ( defined($opts->{command}) ) {
$term->process_a_cmd($opts->{command});
cli_quit($term,undef); # Needed else we leave a foo.lock file behind
} else {
$term->run();
}
exit;
############################################################################
############################################################################
############################################################################
sub open_kdb {
my $file=shift @_;
my $key_file=shift @_;
our $state;
# Make sure the file exists, is readable, and is a keepass file
if (! -f $file) {
return "File does not exist: $file";
}
if (! -r $file) {
return "File is not readable: $file";
}
if (magic_file_type($file) ne 'keepass') {
return "Does not appear to be a KeePass file: $file";
}
# Look for lock file and warn if it is found
my $lock_file = $file . '.lock'; # KeePassX style
if (-f $lock_file &&
! (defined($opts->{readonly}) && int($opts->{readonly})) ) {
print color('bold yellow') .
"WARNING:" .
color('clear') . color('red') .
" A KeePassX-style lock file is in place for this file.\n" .
" It may be opened elsewhere." .
" " . color('bold yellow') . "Be careful of saving!\n" .
color('clear');
} else {
$state->{placed_lock_file} = $lock_file;
}
my $master_pass;
if ( defined($opts->{pwfile}) ) {
# Read the master password from the given file
open(my $pwdfile, '<', $opts->{pwfile});
$master_pass=<$pwdfile>;
chomp $master_pass;
close($pwdfile);
} else {
# Ask the user for the master password and then open the kdb
$master_pass=GetMasterPasswd();
}
if (recent_sigint()) { return undef; } # Bail on SIGINT
$state->{kdb} = File::KeePass->new;
if (! eval { $state->{kdb}->load_db($file,
composite_master_pass($master_pass, $key_file)) }) {
die "Couldn't load the file $file: $@";
}
if ($state->{placed_lock_file}) {
touch_file($state->{placed_lock_file});
}
# We hold a read file handle open for no reason other than
# to show up in lsof.
if (defined($state->{kdb_file_handle})) {
close $state->{kdb_file_handle};
}
$state->{kdb_file_handle} = new FileHandle;
open($state->{kdb_file_handle}, '<', $file);
$state->{kdb_file} = $file;
$state->{key_file} = $key_file;
$state->{kdb_ver} = $state->{kdb}->{header}->{version}; # will be 1 or 2
$state->{put_master_passwd}($master_pass);
$state->{kdb_has_changed}=0;
$master_pass="\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
# Build the %all_grp_paths_fwd and %all_grp_paths_rev structures
refresh_state_all_paths();
# Store the md5sum of the file so we can watch for unexpected changes
$state->{kdb_file_md5} = Digest::file::digest_file_hex($file, "MD5");
# Initialize our state into "/"
cli_cd($term, {'args' => ["/"]});
return ''; # If we return anything else it is an error message
}
# Called by Term::ShellUI to get the user prompt
sub term_set_prompt($$) {
my $term=shift @_;
my $raw_cmd=shift @_;
our $state;
my $app=$state->{appname};
my $pwd=get_pwd();
return "$app:$pwd> ";
}
# Walks through a tree of groups building a flat hash of NULL-separated
# paths to group IDs. Called on the root to build a full path tree.
sub build_all_group_paths {
my $hash = shift @_;
my $g = shift @_;
my $root_path = shift @_ || [];
foreach my $me (@{$g}) {
my @path_to_me = @{$root_path};
push @path_to_me, $me->{title};
my $path=join("\0",@path_to_me);
my $err_path = '/' . humanize_path($path);
if (defined($hash->{$path})) {
print color('bold yellow') . "WARNING: " . color('clear') .
color('red') . "Multiple groups titled: $err_path!\n" .
color('red') . "This is unsupported and may cause data loss!\n" .
color('clear');
}
$hash->{$path}=$me->{id};
if (defined($me->{groups})) {
build_all_group_paths($hash,$me->{groups},\@path_to_me);
}
}
return (scalar(keys(%{$hash})));
}
# Walks through a tree of groups building a flat hash of NULL-separated
# paths to entry IDs. Called on the root to build a full path tree.
sub build_all_entry_paths {
my $hash = shift @_;
my $g = shift @_;
my $root_path = shift @_ || [];
my $red=color('red');
foreach my $me (@{$g}) {
my @path_to_me = @{$root_path};
push @path_to_me, $me->{title};
if (defined($me->{entries})) {
ENTRY: foreach my $ent (@{$me->{entries}}) {
if ($ent->{'title'} eq 'Meta-Info' && $ent->{'username'} eq 'SYSTEM') {
next ENTRY; # skip Meta-Info/SYSTEM entries
}
my $path=join( "\0", (@path_to_me, $ent->{title}) );
my $err_path = '/' . humanize_path($path);
if ($ent->{title} eq '') {
print color('bold yellow') . "WARNING: " . color('clear') .
$red . "There is an entry with a blank title in $err_path!\n" .
color('clear');
}
if (defined($hash->{$path}) &&
$err_path !~ m/\/Backup\/|\/Meta-Info$/) {
print color('bold yellow') . "WARNING: " . color('clear') .
$red . "Multiple entries titled: $err_path!\n" .
$red . "This is unsupported and may cause data loss!\n" .
color('clear');
}
$hash->{$path}=$ent->{id};
}
}
if (defined($me->{groups})) {
build_all_entry_paths($hash,$me->{groups},\@path_to_me);
}
}
return (scalar(keys(%{$hash})));
}
# Returns the current path the user is sitting in.
sub get_pwd {
my $pwd='';
if (defined($state->{all_grp_paths_rev}->{$state->{path}->{id}})) {
$pwd=$state->{all_grp_paths_rev}->{$state->{path}->{id}};
}
$pwd =~ s%/%\\/%g;
$pwd =~ s/\0/\//g;
$pwd = '/' . $pwd;
return $pwd;
}
# Destroys our /_found group (where we place search results)
sub destroy_found {
our $state;
# Look for an exising /_found and kill it if it exists
my $k=$state->{kdb};
my $found_group=$k->find_group({level=>0,title=>$FOUND_DIR});
if (defined($found_group)) {
my @oldents = $k->find_entries({group=>$found_group->{id}});
foreach my $ent (@oldents) {
$k->delete_entry({id => $ent->{id}});
}
$k->delete_group({level=>0,title=>$FOUND_DIR});
# Because we destroyed /_found we must refresh our $state paths
refresh_state_all_paths();
}
}
# Refreshes $state->{all_grp_paths_fwd} and $state->{all_grp_paths_rev}
sub refresh_state_all_paths() {
our $state;
# Build all group paths
my %all_grp_paths_fwd;
build_all_group_paths(\%all_grp_paths_fwd,$state->{kdb}->groups);
my %all_grp_paths_rev = reverse %all_grp_paths_fwd;
$state->{all_grp_paths_fwd}=\%all_grp_paths_fwd;
$state->{all_grp_paths_rev}=\%all_grp_paths_rev;
# Build all entry paths
my %all_ent_paths_fwd;
build_all_entry_paths(\%all_ent_paths_fwd,$state->{kdb}->groups);
my %all_ent_paths_rev = reverse %all_ent_paths_fwd;
$state->{all_ent_paths_fwd}=\%all_ent_paths_fwd;
$state->{all_ent_paths_rev}=\%all_ent_paths_rev;
}
# Gathers the list of groups and entries for the pwd we're sitting in
sub get_current_groups_and_entries {
return get_groups_and_entries(get_pwd());
}
sub get_groups_and_entries {
my $path=shift @_;
our $state;
my $k=$state->{kdb};
# Collect the @groups and entries
my @groups=();
my @entries=();
my $norm_path = normalize_path_string($path);
if (length($norm_path) < 1) {
@groups = $k->find_groups({level=>0});
@entries = $k->find_entries({level => 0});
} else {
my $id=$state->{all_grp_paths_fwd}->{$norm_path};
my ($this_grp,@trash) = $k->find_groups({id=>$id});
if (defined($this_grp->{groups})) { # subgroups
@groups = @{$this_grp->{groups}};
}
@entries = $k->find_entries({group_id => $id});
}
# Remove Meta-Info/SYSTEM entries
my @non_meta_info = ();
foreach my $ent (@entries) {
if (!($ent->{'title'} eq 'Meta-Info' && $ent->{'username'} eq 'SYSTEM')) {
push @non_meta_info, $ent;
}
}
@entries = @non_meta_info;
# Sort the results
@groups = sort group_sort @groups;
@entries = sort { ncmp($a->{title},$b->{title}); } @entries;
return (\@groups,\@entries);
}
# This function takes a group ID and returns all of the child
# groups of that group, flattened.
sub all_child_groups_flattened {
my $group_id=shift @_;
our $state;
my $k=$state->{kdb};
my @groups=();
my ($this_grp,@trash) = $k->find_groups({id=>$group_id});
if (defined($this_grp->{groups})) { # subgroups
@groups = @{$this_grp->{groups}};
foreach my $child_group (@groups) {
push @groups, all_child_groups_flattened($child_group->{id});
}
}
return @groups;
}
# A function to properly sort groups by title
sub group_sort($$) {
my $a=shift @_;
my $b=shift @_;
# _found at level 0 is a special case (from our find command).
if ($a->{title} eq $FOUND_DIR && $a->{level} == 0) {
return 1;
} elsif ($b->{title} eq $FOUND_DIR && $b->{level} == 0) {
return -1;
# Backup at level=0 is a special case (KeePassX's Backup group).
} elsif ($a->{title} eq 'Backup' && $a->{level} == 0) {
return 1;
} elsif ($b->{title} eq 'Backup' && $b->{level} == 0) {
return -1;
# "Recycle Bin" at level=0 is a special case (KeePass v2).
} elsif ($a->{title} eq 'Recycle Bin' && $a->{level} == 0) {
return 1;
} elsif ($b->{title} eq 'Recycle Bin' && $b->{level} == 0) {
return -1;
# Sort everything else naturally (Sort::Naturally::ncmp).
} else {
return ncmp($a->{title},$b->{title}); # Natural sort
}
}
# -------------------------------------------------------------------------
# All of the cli_*() functions are below here
# -------------------------------------------------------------------------
# A simple wrapper function to block SIGTSTP (^Z) during certain commands
sub run_no_TSTP {
my $func = shift @_;
$SIG{TSTP}='IGNORE';
my @retval = &$func(@_);
$SIG{TSTP}='DEFAULT';
return @retval;
}
# Checks passwords for their quality
sub cli_pwck {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
# Try to load one of the optional modules needed by this feature.
# This list is in order of preference.
my @pwckModules = qw(Data::Password::passwdqc Data::Password);
my $pwckMethod = '';
pwckModules: foreach my $pwckmod (@pwckModules) {
# If it's already loaded then set $pwckMethod and bail out now
if ($state->{OPTIONAL_PM}->{$pwckmod}->{loaded}) {
$pwckMethod = $pwckmod;
last pwckModules;
}
# Try to load it. If we succeed, set $pwckMethod and bail out
if (runtime_load_module(\%OPTIONAL_PM,$pwckmod,undef)) {
if ($pwckmod eq 'Data::Password::passwdqc') {
$Data::Password::passwdqc::max=999; # Max password length allowed
$Data::Password::passwdqc::min=[INT_MAX, 20, 11, 8, 7]; # man pwqcheck
} elsif ($pwckmod eq 'Data::Password') {
#no warnings 'once';
$Data::Password::MINLEN = 8;
$Data::Password::MAXLEN = 0;
}
$pwckMethod = $pwckmod;
last pwckModules;
}
}
# If we could not get a module loaded, let the user know and bail out
if (! length($pwckMethod)) {
print "Error: pwck requires Data::Password or Data::Password::passwdqc.\n";
return;
}
# Tell the user which module we are using for password testing.
print "Using perl module $pwckMethod for password testing...\n\n";
my @targets = ();
my $target = $params->{args}->[0];
# Start by trying to find a single entity with the paramter given.
# If no single entity is found then try to find entities based on
# assuming that the path given is a group.
my $ent=find_target_entity_by_number_or_path($target);
if (defined($ent)) {
push @targets, $ent;
} else {
my @groups = ();
my $target = normalize_path_string($target);
if ($target eq '' || $target eq '.' && get_pwd() eq '/') {
@groups = $state->{kdb}->find_groups({}); # Every group in the file!
} elsif (defined($state->{all_grp_paths_fwd}->{$target})) {
my $group_id = $state->{all_grp_paths_fwd}->{$target};
my $this_grp = $state->{kdb}->find_group( { id => $group_id } );
@groups = all_child_groups_flattened($group_id);
push @groups, $this_grp; # Push this group onto its children
}
# Loop over each target group adding each of its entries as targets
foreach my $group (@groups) {
if (defined($group->{entries})) {
ENTRY: foreach my $ent (@{$group->{entries}}) {
# skip Meta-Info/SYSTEM entries
if ($ent->{'title'} eq 'Meta-Info' &&
$ent->{'username'} eq 'SYSTEM') {
next ENTRY;
}
# If we don't have this entry recorded in all_ent_paths_rev then
# we can't report on it. The only case known of is when we have
# multiple entries at the same level (unsupported) and typically
# that's only seen in /Backup in v1 databases.
if (defined($state->{all_ent_paths_rev}->{$ent->{id}})) {
push @targets, $ent;
} elsif (! ($group->{title} eq 'Backup' && $group->{level} == 0)) {
warn "Warning: missing entry " . &Dumper($ent) . "\n";
next;
}
}
}
}
}
# Test each password, collect the results and record empty passwords
my %results=();
my @empties = ();
print " working...\r";
my @busy_chars = qw(\ | / -); my $i=0; my $in=10;
foreach my $ent (@targets) {
printf "%s\r", $busy_chars[int($i/$in)%($#busy_chars+1)] if (!($i++ % $in));
my $pass = $state->{kdb}->locked_entry_password($ent);
if (length($pass) == 0) {
push @empties, $ent;
$results{$ent->{id}} = '';
} else {
$results{$ent->{id}} = my_IsBadPassword($pwckMethod, $pass);
}
# If the user hit ^C (SIGINT) then we need to stop
if (recent_sigint()) {
print "\r"; # Need to return to column 0 of the output line
return 0;
}
}
# If we only analyzed one password, return singular-style results
if (scalar(@targets) == 1) {
my $ent=$targets[0];
if (length($results{$ent->{id}})) {
print "Password concerns: " . $results{$ent->{id}} . "\n";
} elsif (scalar(@empties) > 0) {
print "Password field is empty.\n";
} else {
print "Password strength is good.\n";
}
} else {
# If we analyzed more than one password, return multiple-style results
my %problems=();
foreach my $ent_id (keys %results) {
if (length($results{$ent_id})) {
$problems{$state->{all_ent_paths_rev}->{$ent_id}} = $ent_id;
}
}
my $analyzed = scalar(@targets);
my $problem_count = scalar(keys %problems);
my $empty_count = scalar(@empties);
print "$analyzed passwords analyzed, $empty_count blank, " .
"$problem_count concerns found";
if ($problem_count > 0) { print ":\n"; } else { print "."; }
print "\n";
foreach my $path (sort keys %problems) {
print humanize_path($path) . ": $results{$problems{$path}}\n";
if (! length(humanize_path($path))) {
my $ent_id = $problems{$state->{all_ent_paths}->{$path}};
my $ent = $state->{kdb}->find_entry({id => $ent_id});
warn "LHHD: ".&Dumper($ent)."\n";
}
}
}
return 0;
}
# This function handles abstraction to mutiple password
# quality checking libraries.
sub my_IsBadPassword($) {
my $pwckMethod = shift @_;
my $pass = shift @_;
my $result = undef;
if ($pwckMethod eq 'Data::Password') {
$result = Data::Password::IsBadPassword($pass);
if ($result =~ m/dictionary word/i) {
# IsBadPassword() reports dictionary words that it finds. I don't
# like that from a security perspective so we change that here.
$result = "contains a dictionary word";
}
} elsif ($pwckMethod eq 'Data::Password::passwdqc') {
my $pwdqc = Data::Password::passwdqc->new;
my $is_valid = $pwdqc->validate_password($pass);
$result = $pwdqc->reason if not $is_valid;
}
return $result;
}
# Prints some statistics about the open KeePass file
sub cli_stats {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
# Group and entry counts
my %stats;
$stats{group_count} = scalar(keys(%{$state->{all_grp_paths_fwd}}));
$stats{entry_count} = scalar(keys(%{$state->{all_ent_paths_fwd}}));
# Password lengths
my $k=$state->{kdb};
my %password_lengths;
print " working...\r";
my @busy_chars = qw(\ | / -); my $i=0; my $in=100;
foreach my $ent_id (values(%{$state->{all_ent_paths_fwd}})) {
printf "%s\r", $busy_chars[int($i/$in)%($#busy_chars+1)] if (!($i++ % $in));
my $ent = $k->find_entry({id => $ent_id});
my $pass_len = length($k->locked_entry_password($ent));
if ($pass_len < 1) {
$password_lengths{"0"}++;
} elsif ($pass_len > 0 && $pass_len < 8) {
$password_lengths{"1-7"}++;
} elsif ($pass_len > 7 && $pass_len < 12) {
$password_lengths{"8-11"}++;
} elsif ($pass_len > 11 && $pass_len < 17) {
$password_lengths{"12-16"}++;
} elsif ($pass_len > 16 && $pass_len < 20) {
$password_lengths{"17-19"}++;
} elsif ($pass_len > 19) {
$password_lengths{"20+"}++;
}
# If the user hit ^C (SIGINT) then we need to stop
if (recent_sigint()) {
print " "x20 . "\r"; # Need to return to column 0 of the output line
return 0;
}
}
my $t= " "x20 . "\r" .
"File: " . $state->{kdb_file} . "\n" .
"Key file: " .
(defined($state->{key_file}) ? $state->{key_file} : 'N/A') . "\n";
if (defined($k->{header}->{database_name})) {
$t.="Name: " . $k->{header}->{database_name} . "\n";
}
if (defined($k->{header}->{database_description})) {
my $desc = $k->{header}->{database_description};
$desc =~ s/[\r\n]/\n/g;
my @l = split(/\n/, $desc);
$t .= "Description:\n" . "| " . join("\n| ", @l) . "\n";
}
$t .= "KeePass file version: " . $k->{header}->{version} . "\n" .
"Encryption type: " . $k->{header}->{enc_type} . "\n" .
"Encryption rounds: " . $k->{header}->{rounds} . "\n";
if (defined($k->{header}->{cipher})) {
$t.="Cipher: $stats{cipher}\n";
}
if (defined($k->{header}->{compression})) {
$t.="Compression: $stats{compression}\n";
}
$t .= "Number of groups: $stats{group_count}\n" .
"Number of entries: $stats{entry_count}\n" .
"Entries with passwords of length:\n".stats_print(\%password_lengths) .
"\n" .
"";
print $t;
}
sub cli_cls {
if (lc($OSNAME) =~ m/^mswin/ &&
(! $OPTIONAL_PM{'Win32::Console::ANSI'}->{loaded})) {
system("cls");
} else {
print "\033[2J\033[0;0H";
$|=1; # Needed for MS Windows (Win32::Console::ANSI works w/this flush)
}
}
sub cli_pwd {
print get_pwd() . "\n";
}
sub cli_cd {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
my $raw_pathstr = $params->{args}->[0];
# "cd ."
if ($raw_pathstr =~ m/^[.]$/) {
return; # nothing to do
}
# "cd -"
if ($raw_pathstr =~ m/^[-]$/) {
return cli_cd($self, {'args' => [$state->{oldpwd}]});
}
# Everything else is handled by helpers
return cli_cd_helper($state,normalize_path_string($raw_pathstr));
}
# Takes a possibly wacky path with ".."s and such and normalizes it into a
# NULL-separated path that can be used as a key into $state->{all_grp_paths_fwd}
sub normalize_path_string($) {
my $path_string = shift @_;
our $state;
if ($path_string =~ m/\0/) {
warn "normalize_path_string(\"$path_string\"): path contains a NULL. Likely a bug.\nPlease report it at https://sourceforge.net/p/kpcli/bugs/!\n";
}
# Split the path into @path
# http://efreedom.com/Question/1-3588341/Implement-Escape-Sequence-Using-Split-Perl
my $delim="/";
my $escape="\\";
my @path = $path_string =~
/(?:\Q$delim\E|^)((?>(?:\Q$escape\E.|(?!\Q$delim\E).)*))/gs;
#/(?:\Q$delim\E|^)((?:\Q$escape\E.|(?!\Q$delim\E).)*+)/gs; # perl 5.10+
s/\Q$escape$delim\E/$delim/g for @path;
@path=grep(!/^$/, @path); # Drop meaningless (excess) deimiters (/foo//bar)
# This block handles absolute and relative paths
my $path_str='';
if ($path_string =~ m%^/%) { # Absolute path
$path_str=join("\0",@path);
} else { # Relative path
my $pwd=$state->{all_grp_paths_rev}->{$state->{path}->{id}};
my @nwd=split("\0", $pwd);
push @nwd, @path;
$path_str=join("\0", @nwd);
}
# We should now have a NULL-separated, fully qualified path and
# we just need to work on cleaning up things like "." and ".."
# Squash single dots
while ($path_str=~s/\0[.]\0|^[.]\0|\0[.]$/\0/) {}
# Kill ".." and their parents
while ($path_str=~s/[^\0]+\0+[.][.]//) {}
$path_str=~s/\0\0+/\0/g; # squash any adjacent delimeters
$path_str=~s/^\0+//; # squash any leading delimeters
$path_str=~s/\0+$//; # squash any trailing delimeters
return $path_str;
}
sub cli_cd_helper($$) {
my $state=shift @_;
my $path_str=shift @_;
if (defined($state->{all_grp_paths_fwd}->{$path_str})) {
$state->{oldpwd}=get_pwd();
my $id=$state->{all_grp_paths_fwd}->{$path_str};
$state->{path}->{id}=$id;
return 0;
} elsif ($path_str eq '') { # cd /
$state->{oldpwd}=get_pwd();
delete $state->{path};
return 0;
} else {
print "Invalid path\n";
return -1;
}
}
# Return 1 if entry's password never expires, else 0.
# Helps support both v1 (*.kdb) and v2 (*.kdbx) files.
sub does_expire_never {
my $kdb_ver = shift @_;
my $ent = shift @_;
my $expires = $ent->{expires};
if ($kdb_ver == 1 && $expires =~ m/^(\d{4})-/ && ($1 == 2999)) {
return 1;
} elsif ($kdb_ver == 2 && (! $ent->{expires_enabled})) {
return 1;
}
return 0;
}
# Helper function of cli_find() to find expired entries.
sub find_expired_entries {
my $kdb_ver = shift @_;
my $k = shift @_;
our $state;
my @expired = ();
my @all_entries_flattened = $k->find_entries({});
ENT: foreach my $ent (@all_entries_flattened) {
if (recent_sigint()) { return (); } # Bail on SIGINT
# If we don't have this entry recorded in all_ent_paths_rev then
# we can't report on it. The only case known of is when we have
# multiple entries at the same level (unsupported) and typically
# that's only seen in /Backup in v1 databases.
if (! defined($state->{all_ent_paths_rev}->{$ent->{id}})) {
next ENT;
}
# Now test the expired time...
if (does_expire_never($kdb_ver, $ent)) { next ENT; }
my $exp = $ent->{expires};
my $title = $ent->{title};
if ($exp !~ m/^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})$/) {
print "Warning: Invalid expiration date found in \"$title\"\n";
next ENT;
}
my ($year,$mon,$mday,$hour,$min,$sec) = ($1, $2, $3, $4, $5, $6);
my $timegm = timegm($sec,$min,$hour,$mday,$mon-1,$year);
if ($timegm < time) {
push @expired, $ent;
}
}
return @expired;
}
sub cli_purge($$) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
# Users can provide a --no-recycle option and -r for recurse.
my $target = undef;
my $purge_group='';
my %opts=();
{
local @ARGV = @{$params->{args}};
my $result = &GetOptions(\%opts, 'r', 'no-recycle');
if (scalar(@ARGV) != 1 || length($ARGV[0]) < 1) {
print "Purge only supports exactly one group at a time.\n";
return;
}
$target = normalize_path_string($ARGV[0]);
if (defined($state->{all_grp_paths_fwd}->{$target})) {
my $group_id = $state->{all_grp_paths_fwd}->{$target};
$purge_group = $state->{kdb}->find_group( { id => $group_id } );
} else {
print "Invalid group.\n";
return;
}
}
# Collect the date/time field that the user wants to purge by
print "Purge by (c)reated, (e)xpires, or last (a)ccessed/(m)odified time? ";
my $purge_by=get_single_key();
print "\n";
if ($purge_by !~ m/^[ecam]$/i) {
print "Operation canceled.\n";
return;
}
# Ask the user for the $purge_qty and $purge_uom
print "Purge entries order than... (90d, 13w, 6m, 2y, etc)? ";
my $purge_age = get_single_line();
print "\n";
my ($purge_qty, $purge_uom) = (undef, undef);
if ($purge_age !~ m/^(\d+)([dwmy])$/i) {
print "Invalid age specified.\n" .
"\n" .
"Examples:\n" .
" - 90d = 90 days\n" .
" - 13w = 13 weeks\n" .
" - 6m = 6 months\n" .
" - 2y = 2 years\n" .
"\n" .
"Operation canceled.\n";
return;
} else {
($purge_qty, $purge_uom) = ($1, $2);
}
# Make a $purge_time Time::Piece object for the user's chosen purge time
my $time_now = Time::Piece->new;
my $purge_time = undef;
if ($purge_uom eq 'd') {
$purge_time = $time_now - ONE_DAY * $purge_qty;
} elsif ($purge_uom eq 'w') {
$purge_time = $time_now - 7 * ONE_DAY * $purge_qty;
} elsif ($purge_uom eq 'm') {
$purge_time = $time_now->add_months(-1*$purge_qty);
} elsif ($purge_uom eq 'y') {
$purge_time = $time_now->add_years(-1*$purge_qty);
}
# Gather the @groups and @ents that are purge candidates
my @groups = ($target);
if ($opts{'r'}) {
my @child_grps = grep(/^\Q$target\E\0/,
sort(keys(%{$state->{all_grp_paths_fwd}})));
foreach my $grp (@child_grps) {
push @groups, $grp;
}
}
my @ents = ();
foreach my $grp (@groups) {
my @ent_paths = grep(/^\Q$grp\E\0[^\0]+$/,
sort(keys(%{$state->{all_ent_paths_fwd}})));
foreach my $ent_path (@ent_paths) {
my $entry_id = $state->{all_ent_paths_fwd}->{$ent_path};
my $ent = $state->{kdb}->find_entry( {id=>$entry_id} );
push @ents, $ent;
}
}
# Place the "entries to purge" into @purge_ents
my %byK = (
'e' => 'expires', 'c' => 'created',
'a' => 'accessed', 'm' => 'modified',
);
my @purge_ents = ();
foreach my $ent (@ents) {
my $ent_time = $ent->{$byK{$purge_by}}; # %Y-%m-%d %H:%M:%S
$ent_time =~ s/[^0-9]//g;
my $prg_time = $purge_time->strftime("%Y%m%d%H%M%S");
if ($ent_time =~ m/^\d{14}$/ && $ent_time < $prg_time) {
push @purge_ents, $ent;
}
}
if (scalar(@purge_ents) < 1) {
print "No entries match your purge criteria. Nothing to purge.\n";
return;
}
# Show the user the imact this purge will have and request confirmation
my %byV = (
'e' => 'expired', 'c' => 'created',
'a' => 'last accessed', 'm' => 'last modified',
);
my %uomV = (
'd' => 'day(s)', 'w' => 'week(s)',
'm' => 'month(s)', 'y' => 'year(s)',
);
my $recursivelyV='';
if ($opts{'r'}) { $recursivelyV = "recursively " }
print "\n";
print "For group \"$purge_group->{title}\"\n" .
" - " . $recursivelyV . "purge entries with $byV{$purge_by} dates " .
"older than $purge_qty $uomV{$purge_uom}.\n" .
" - $purge_qty $uomV{$purge_uom} ago is " .
$purge_time->strftime("%Y-%m-%d at %H:%M:%S") . "\n" .
" - this will purge " .scalar(@purge_ents). " of " .scalar(@ents) .
" entries in " .scalar(@groups). " groups.\n";
if ($opts{'no-recycle'}) {
print " - and with --no-recycle specified, no backups will be made!\n";
}
print "\n";
print "Confirm if you would you like to do this? [y/N] ";
my $key=get_single_key();
if (recent_sigint()) { return undef; } # Bail on SIGINT
print "\n";
if (lc($key) ne 'y') {
print "Operation canceled.\n";
return;
}
# Delete the entries that we need to purge
foreach my $ent (@purge_ents) {
# No recycling for "Backup"/"Recycle Bin" folders; other folders
# respect $opts{no-recycle}.
if (! ($opts{'no-recycle'} || ( $purge_group->{level} == 0 &&
($purge_group->{title} eq 'Backup' ||
$purge_group->{title} eq 'Recycle Bin') )) ) {
my $errmsg = recycle_entry($state, $ent);
if (defined($errmsg)) { print "WARNING: $errmsg\n"; }
}
if (recent_sigint()) { return undef; } # Bail on SIGINT
$state->{kdb}->delete_entry({ id => $ent->{id} });
}
# If we purged anything, set kdb_has_changed state, ask to save, etc.
if (scalar(@purge_ents) > 0) {
$state->{kdb_has_changed}=1;
refresh_state_all_paths();
RequestSaveOnDBChange();
}
}
sub cli_find($) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
destroy_found();
# Users can provide a -a option to search more than just the title. We
# use GetOpts to parse this command line.
my $search_str='';
my %opts=();
{
local @ARGV = @{$params->{args}};
my $result = &GetOptions(\%opts, 'a', 'expired');
if (defined($opts{'expired'})) {
if (scalar(@ARGV) || scalar(keys(%opts)) > 1) {
print "-expired cannot have search criteria or other qualifiers.\n";
return;
}
} else {
if (scalar(@ARGV) != 1) {
print "Find only supports searching for one word.\n";
return;
}
$search_str = $ARGV[0];
}
}
my @e = ();
my $k=$state->{kdb};
if (length($search_str)) {
print "Searching for \"$search_str\" ...\n";
# Make $search_str a case-insensitive regex
my @letters=split(//, $search_str);
foreach my $l (@letters) {
if (uc($l) ne lc($l)) {
$l='[' . uc($l) . lc($l) . ']';
}
}
$search_str=join('', @letters);
my @srch_flds = qw(title);
if ($opts{'a'}) {
@srch_flds = qw(title username comment url tags);
}
foreach my $fld (@srch_flds) {
# Search entries by title, skipping the /Backup (*.kdb) and/or
# "/Recycle Bin" groups if they exists
my $search_params = { "$fld =~" => $search_str };
foreach my $bu_dir ('/Backup','/Recycle Bin') {
my $backup_dir_normalized=normalize_path_string($bu_dir);
if (defined($state->{all_grp_paths_fwd}->{$backup_dir_normalized})) {
$search_params->{'group_id !'} =
$state->{all_grp_paths_fwd}->{$backup_dir_normalized};
}
}
push @e, $k->find_entries($search_params);
}
} elsif (defined($opts{'expired'})) {
@e = find_expired_entries($state->{kdb_ver}, $k);
}
# Remove Meta-Info/SYSTEM entries
my @non_meta_info = ();
foreach my $ent (@e) {
if (!($ent->{'title'} eq 'Meta-Info' && $ent->{'username'} eq 'SYSTEM')) {
push @non_meta_info, $ent;
}
}
@e = @non_meta_info;
if ( scalar(@e) < 1) {
print "No matches.\n";
return;
}
# If we get this far we have results to add to a new /_found
my $found_group = $k->add_group({title => $FOUND_DIR}); # root level group
my $found_gid = $found_group->{'id'};
$k->unlock;
my @matches=();
my %duplicates=();
FINDS: foreach my $ent (@e) {
my %new_ent = %{clone($ent)}; # Clone the entity
$new_ent{id} = int(rand(1000000000000000)); # A random new id
$new_ent{group} = $found_gid; # Place this entry clone into /_found
# $new_ent{path} is _NOT_ a normal key for File::KeePass but this is
# safe because we are adding it to entries in the /_found group which
# will not be saved to a file.
my $nulled_path=$state->{all_ent_paths_rev}->{$ent->{id}};
$new_ent{full_path} = '/' . humanize_path($nulled_path);
$new_ent{path} = dirname($new_ent{full_path}) . '/';
if (defined($duplicates{$new_ent{full_path}})) { next FINDS; }
$duplicates{$new_ent{full_path}} = 1;
$k->add_entry(\%new_ent);
push(@matches, \%new_ent);
# If the user hit ^C (SIGINT) then we need to stop
if (recent_sigint()) {
# If we delete the $FOUND_DIR group it should be safe to leave
$k->delete_group({title => $FOUND_DIR});
return undef;
}
}
$k->lock;
# Because we added a new /_found we must refresh our $state paths
refresh_state_all_paths();
# Tell the user what we found
print " - ".scalar(@matches)." matches found and placed into /$FOUND_DIR/\n";
# If we only found one, ask the user if they want to see it
if (scalar(@matches) == 1) {
print "Would you like to show this entry? [y/N] ";
my $key=get_single_key();
print "\n";
if (lc($key) eq 'y') {
my $search_params = { 'group_id =' => $found_gid };
my ($e,@empty) = $k->find_entries($search_params);
my $full_path="/$FOUND_DIR/" . $e->{title};
my $show_args = [ $full_path ];
# If we are doing an expired password search, find only one entry,
# and give the user the option to show it, we want to show the
# expired time, and so we add -a here.
if (defined($opts{'expired'})) { push @{$show_args}, '-a'; }
cli_show($self, { args => $show_args });
}
} elsif (scalar(@matches) > 1) {
print "Would you like to list them now? [y/N] ";
my $key=get_single_key();
print "\n";
if (lc($key) eq 'y') {
cli_ls($self,{"args" => ["/$FOUND_DIR/"]});
}
}
}
# Something is going wrong between KeePassX and File::KeePass related to
# the unknown values read/written by File::KeePass from/to files written
# by KeePassX. Commenting out line 378 of File/KeePass.pm is one fix,
# this prevents me from needing to do that by just removing the unknown
# values before saving. If there is a downside to this on the KeePassX
# side I've not found it yet. I do have an email out to Paul, the author
# of File::KeePass, requesting some assistance in grokking the problem.
#
# NOTE: I thought that this should not be needed for File::Keepass >= 0.3,
# but on 2011-02-02 I discovered that creating new groups with
# File::Keepass and not scrubbing on save created corrupt files:
# "Group header offset is out of range" errors.
# Sourceforge bug# 3187054 demonstrated the problem as well.
sub scrub_unknown_values_from_all_groups {
our $state;
# No need to do this with newer versions of File::KeePass (fixed in 2.01)
if (version->parse($File::KeePass::VERSION) >= version->parse('2.03')) {
return;
}
my $k=$state->{kdb};
my @all_groups_flattened = $k->find_groups({});
my @unkown_field_groups=();
foreach my $g (@all_groups_flattened) {
if (defined($g->{unknown})) {
#warn "LHHD: " . &Dumper($g->{unknown}) . "\n";
delete $g->{unknown};
push @unkown_field_groups, $g->{title};
}
}
my $count = scalar(@unkown_field_groups);
if ($count > 0) {
warn "Deleted unknown fields from these $count groups: " .
join(", ", @unkown_field_groups) . "\n";
}
}
sub deny_if_readonly {
our %opts;
if (defined($opts->{readonly}) && int($opts->{readonly})) {
print "Function not available with --readonly set.\n";
return 1;
}
return 0;
}
sub cli_save($) {
my $self = shift @_;
my $params = shift @_;
if (recent_sigint()) { return undef; } # Bail on SIGINT
if (deny_if_readonly()) { return; }
our $state;
if (! length($state->{kdb_file})) {
print "Please use the saveas command for new files.\n";
return;
}
# If the user has asked for a *.kdbx file, check the File::KeePass version
if (version->parse($File::KeePass::VERSION) < version->parse('2.03')) {
if ($state->{kdb_file} =~ m/\.kdbx$/i) {
print "KeePass v2 (*.kdbx files) require File::KeePass >= v2.03\n";
return;
}
}
if (warn_if_file_changed()) {
return;
}
# Check for a lock file that we did not place there
my $lock_file = $state->{kdb_file} . '.lock'; # KeePassX style
if (-f $lock_file && $state->{placed_lock_file} ne $lock_file) {
print color('bold yellow') . "WARNING:" . color('clear') .
color('red') .
" A KeePassX-style lock file is in place for this file.\n" .
" It may be opened elsewhere. Save anyway? [y/N] " .
color('clear');
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
return;
}
}
# If we got this far the user is OK with us locking the file even
# if we had a contention.
touch_file($lock_file);
$state->{placed_lock_file} = $lock_file;
# Scrub the data and write the file
destroy_found();
scrub_unknown_values_from_all_groups(); # TODO - remove later
my $k=$state->{kdb};
$k->unlock;
my $master_pass=
composite_master_pass($state->{get_master_passwd}(),$state->{key_file});
# Note: adding the 3rd parameter (header) here was in response to a bug reported
# on 03/27/2016 via email to me from a person named marco. There is a bug in
# File::KeePass that will make this save_db() call revert a V2 database to v1 if
# the filename does not end in kdbx. Passing the header to this call here works
# around that bug (a failure to store the version in $self->{version}). I'm not
# changing this on cli_saveas(), else you could not change the DB versions by
# using that command with different file extensions. I opened a bug report,
# here: https://rt.cpan.org/Ticket/Display.html?id=113391
#
# I also decided to do this only in the case where a user has a V2 file opened
# and the filename does not end in kdbx, so that the impact of this change is
# minimized across the user base.
if ($state->{kdb_file} !~ m/\.kdbx$/i && $state->{kdb}->{header}->{version} == 2) {
$k->save_db($state->{kdb_file},$master_pass,$state->{kdb}->{header});
} else {
$k->save_db($state->{kdb_file},$master_pass);
}
$state->{kdb_has_changed}=0; # set our state to no change since last save
$master_pass="\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
print "Saved to $state->{kdb_file}\n";
$k->lock;
my $file = $state->{kdb_file};
# We hold a read file handle open for no reason other than
# to show up in lsof.
if (defined($state->{kdb_file_handle})) {
close $state->{kdb_file_handle};
}
$state->{kdb_file_handle} = new FileHandle;
open($state->{kdb_file_handle}, '<', $file);
# Update the md5sum of the file after we just saved it
$state->{kdb_file_md5} = Digest::file::digest_file_hex($file, "MD5");
}
# This subroutine handles the clipboard commands (xw, xu, xp, and xx)
sub cli_xN($$) {
my $xNcmd = shift @_;
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
# If Clipboard is not avaiable we can't do this for the user
if (! $state->{OPTIONAL_PM}->{'Clipboard'}->{loaded}) {
print "Error: $xNcmd requires the Clipboard and Capture::Tiny modules:\n" .
" - http://search.cpan.org/~king/Clipboard/\n" .
" - http://search.cpan.org/~dagolden/Capture-Tiny/\n" .
"";
if (defined($state->{OPTIONAL_PM}->{'Clipboard'}->{error})) {
print "\nThere was an error loading the Clipboard module, as follows:\n" .
$state->{OPTIONAL_PM}->{'Clipboard'}->{error} . "\n";
}
return;
}
# If we're clearing the clipboard, just do that and return immediately.
if ($xNcmd eq 'xx') {
Clipboard->copy('');
print "Clipboard cleared.\n";
return;
}
# Find the entry that the user wants to copy to the clipboard from.
my $target = $params->{args}->[0];
my $ent=find_target_entity_by_number_or_path($target);
if (! defined($ent)) {
print "Don't see an entry at path: $target\n";
return -1;
}
# Switch over the xN commands and place the data into $to_copy
my $to_copy = '';
SWITCH: {
$xNcmd eq 'xu' && do { $to_copy = $ent->{username}; last SWITCH; };
$xNcmd eq 'xw' && do { $to_copy = $ent->{url}; last SWITCH; };
$xNcmd eq 'xp' && do {
$to_copy = $state->{kdb}->locked_entry_password($ent);
last SWITCH; };
warn "Error: cli_xN() does not know how to handle the $xNcmd command.";
$to_copy = undef;
}
# Copy to the clipboard and tell the user what we did.
my $cp_map = {
'xu' => 'username',
'xw' => 'url',
'xp' => 'password',
};
if (defined($to_copy)) {
Clipboard->copy($to_copy);
print "Copied $cp_map->{$xNcmd} for \"$ent->{title}\" to the clipboard.\n";
}
return;
}
sub cli_rm($) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
my $target = $params->{args}->[0];
my $ent=find_target_entity_by_number_or_path($target);
if (! defined($ent)) {
print "Don't see an entry at path: $target\n";
return -1;
}
# Recycle the entry unless --no-recycle
if (! (defined($opts->{'no-recycle'}) && int($opts->{'no-recycle'}))) {
my $errmsg = recycle_entry($state, $ent);
if (defined($errmsg)) { print "WARNING: $errmsg\n"; }
}
$state->{kdb}->delete_entry({ id => $ent->{id} });
$state->{kdb_has_changed}=1;
refresh_state_all_paths();
RequestSaveOnDBChange();
}
sub validate_entry_number($$) {
my $item_number=shift @_;
my $path=shift @_;
our $state;
if (normalize_path_string($path) eq '') {
print "Entries cannot exist in the root path (/).\n";
return -1;
}
if ($item_number !~ m/^[0-9]+$/) {
print "Invalid item number (must be an integer).\n";
return -1;
}
my ($rGrps,$rEnts) = get_groups_and_entries($path);
my $entry_max=scalar(@{$rEnts}) - 1;
if ($entry_max < 0) {
print "Invalid item number. No valid entries in $path.\n";
return -1;
} elsif ($item_number > $entry_max) {
print "Invalid item number. Valid entries in \"$path\" are 0-$entry_max.\n";
return -1;
}
return 0;
}
# This routine takes one parameter that will be either a path
# to an entity or an entity number as shown by the ls command
# and will use $state information such as last_ls_ents to
# return a reference to that entity in the $state-{kdb} database,
# if possible (valid input).
sub find_target_entity_by_number_or_path($) {
my $target=shift @_;
our $state;
my $ent=undef; # hope to populate this in a second...
# This section looks for an entity by an "ls" number
if ($target =~ m/^[0-9]+$/ && scalar(@{$state->{last_ls_ents}}) > 0
&& $target < scalar(@{$state->{last_ls_ents}}) ) {
return @{$state->{last_ls_ents}}[$target];
}
# This section looks by a path name
if (defined $state->{all_ent_paths_fwd}->{normalize_path_string($target)}) {
my $entry_id=$state->{all_ent_paths_fwd}->{normalize_path_string($target)};
$ent = $state->{kdb}->find_entry( {id=>$entry_id} );
}
# If we found the entry, place the path to this entry in the entry record,
# even if it's already there (it may have just changed via cli_mv), if the
# path we have for this entity is not the $FOUND_DIR.
if (defined($ent)) {
my $full_path = '/' .
humanize_path($state->{all_ent_paths_rev}->{$ent->{id}});
my $path = dirname($full_path) . '/';
if ("/$FOUND_DIR/" ne $path) {
$ent->{full_path} = $full_path;
$ent->{path} = $path;
}
}
return $ent;
}
sub cli_rename($$) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
my $target_dir = $params->{args}->[0];
my $dir_normalized=normalize_path_string($target_dir);
my $grp=undef;
if (defined($state->{all_grp_paths_fwd}->{$dir_normalized})) {
my $grp_id = $state->{all_grp_paths_fwd}->{$dir_normalized};
$grp=$state->{kdb}->find_group( { id => $grp_id } );
}
if (! defined($grp)) {
print "Unknown group: $target_dir\n";
return -1;
}
my $prompt = color('clear')."Enter the groups new Title: ";
my $term = get_prepped_readline_term();
my $new_title = $term->readline($prompt);
# If the user hit ^C (SIGINT) then we need to stop
if (recent_sigint()) { return undef; }
chomp($new_title);
if (length($new_title)) {
if ($new_title =~ m/\//) {
print "kpcli cannot support titles with slashes (/) in them.\n";
return undef;
}
# If the titles are the same then there is nothing to do
if ($new_title eq $grp->{title}) { return 0; }
# Check the new title for same-name conflicts in its group
my $path = dirname('/'.humanize_path($dir_normalized));
my $testdir=normalize_path_string("$path/$new_title");
if (defined($state->{all_grp_paths_fwd}->{$testdir})) {
print "An entry titled \"$new_title\" is already in $path.\n";
return undef;
}
# If we passed all of our sanity checks then set the new title
$grp->{title} = $new_title;
} else {
return 0;
}
# Because we renamed a group we must refresh our $state paths
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
}
sub cli_mv {
my $self = shift @_;
my $params = shift @_;
my $src_path = shift @_;
my $target_dir = shift @_;
my $skip_save = shift @_ || 0;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
# The target has to be a group. We start validation there (the target).
my $dir_normalized=normalize_path_string($target_dir);
my $grp=undef;
if (defined($state->{all_grp_paths_fwd}->{$dir_normalized})) {
my $grp_id = $state->{all_grp_paths_fwd}->{$dir_normalized};
$grp=$state->{kdb}->find_group( { id => $grp_id } );
}
if (! defined($grp)) {
print "Unknown group: $target_dir\n";
return -1;
}
# The source (thing we are moving) can be an entity, group, or a
# shell_expansion. Here we figure out which one and prepare to
# exectute the move(s) below.
my $ent=undef;
my $mv_type = undef;
if ($ent=find_target_entity_by_number_or_path($src_path)) {
$mv_type = 'entry';
} elsif (defined($state->{all_grp_paths_fwd}->{normalize_path_string($src_path)})) {
$mv_type = 'group';
} else {
# For shell_expansion moves, we call cli_mv for each shell_expansion item,
# with skip_save set to true.
my @ent_matches = shell_expansion($src_path);
if (scalar(@ent_matches) > 0) {
$mv_type = 'shell_expansion';
foreach my $mv_src (@ent_matches) {
my $skip_save = 1;
cli_mv($self,$params,'/'.humanize_path($mv_src),$target_dir,$skip_save);
}
}
}
if (! defined($mv_type)) {
print "Unknown entity: " . humanize_path($src_path) . "\n";
return -1;
}
# Execute the move of the entry or group.
if ($mv_type eq 'entry') {
# Verify no entry title conflict at the new location
my $new_entry_path=normalize_path_string($target_dir . "/" . $ent->{title});
if (defined($state->{all_ent_paths_fwd}->{$new_entry_path}) ||
defined($state->{all_grp_paths_fwd}->{$new_entry_path})) {
my $path = dirname(humanize_path($new_entry_path));
print "ERROR: already an item named \"$ent->{title}\" at $path/.\n";
return undef;
}
# Unlock the kdb, clone the entry, remove its ID and set its new group,
# add it to the kdb, delete the old entry, then lock the kdb...
$state->{kdb}->unlock;
my %ent_copy = %{clone($ent)}; # Clone the entity
delete $ent_copy{id};
$ent_copy{group} = $grp;
if ($state->{kdb}->add_entry(\%ent_copy)) {
$state->{kdb}->delete_entry({ id=>$ent->{id} });
}
$state->{kdb}->lock;
print "Moved \"$ent->{title}\" to ".dirname(humanize_path($new_entry_path))."/\n";
} elsif ($mv_type eq 'group') {
# Find the group that the user is asking us to move
my $src_grp=$state->{kdb}->find_group(
{id => $state->{all_grp_paths_fwd}->{normalize_path_string($src_path)}});
my $new_group_path=normalize_path_string($target_dir . "/" . $src_grp->{title});
if (defined($state->{all_grp_paths_fwd}->{$new_group_path}) ||
defined($state->{all_ent_paths_fwd}->{$new_group_path})) {
my $path = dirname(humanize_path($new_group_path));
print "ERROR: already an item named \"$src_grp->{title}\" at $path/.\n";
return undef;
}
# Clone the group that is to be moved
my %new_group = %{$src_grp};
# Delete the id and level from the cloned group
delete $new_group{id};
delete $new_group{level};
# Add the group ID of the parent we want to put our clone under
$new_group{group} = $grp->{id}; # Set the new parent group
# Add the clone as a new group
$state->{kdb}->add_group(\%new_group);
# Delete the original group that we just cloned into a new spot
$state->{kdb}->delete_group({ id => $src_grp->{id} });
print "Moved \"$src_grp->{title}/\" to ".dirname(humanize_path($new_group_path))."/\n";
} elsif ($mv_type ne 'shell_expansion') {
print "Unknown error with move command.\n";
return -1;
}
# Because we moved an entry we must refresh our $state paths
if (! $skip_save) {
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
}
}
sub cli_copy {
my $self = shift @_;
my $params = shift @_;
my $src = shift @_;
my $dst = shift @_;
my $skip_save = shift @_ || 0;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
my $source_ent = $src;
my $src_ent=find_target_entity_by_number_or_path($source_ent);
if (! defined($src_ent)) {
print "Unknown entry: $source_ent\n";
return -1;
}
my $target_ent = $dst;
my $trg_ent=find_target_entity_by_number_or_path($target_ent);
if (defined($trg_ent)) {
print "Copy cannot overwrite an existing entry.\n";
return -1;
}
# Unlock the kdb, clone the entry, remove its ID and set its new group,
# add it to the kdb, delete the old entry, then lock the kdb...
$state->{kdb}->unlock;
my %ent_copy = %{clone($src_ent)}; # Clone the entity
$state->{kdb}->lock;
delete $ent_copy{id}; # Remove the entry ID for the new copy
my ($grp_path,$name)=normalize_and_split_raw_path($target_ent);
$ent_copy{title} = humanize_path($name);
# group needs to be set to the ID of the group we may be moving the copy to
my $new_grp_id = $state->{all_grp_paths_fwd}->{$grp_path};
if (! defined($new_grp_id)) {
print "Copy failed due to missing target group ID.\n";
return -1;
} else {
$ent_copy{group} = $new_grp_id;
}
$state->{kdb}->unlock;
if (! $state->{kdb}->add_entry(\%ent_copy)) {
print "Copy failed on add_entry().\n";
$state->{kdb}->lock;
return -1;
}
$state->{kdb}->lock;
# Because we added an entry we must refresh our $state paths
if (! $skip_save) {
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
}
return 0;
}
sub cli_clone($$) {
my $self = shift @_;
my $params = shift @_;
my $src = shift @_;
my $dst = shift @_;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
my $skip_save = 1;
my $retval_copy = cli_copy($self, $params, $src, $dst, $skip_save);
if ($retval_copy) {
return -1;
}
refresh_state_all_paths();
my $target_ent = $params->{args}->[1];
my $ent=find_target_entity_by_number_or_path($target_ent);
if (! (defined($ent) && exists($ent->{id}))) {
print "Copy failed.\n";
return -1;
}
$state->{kdb_has_changed}=1;
my %changes = ();
my $retval_edit = _entry_edit_gui($ent, \%changes);
# Apply the user changes, update modify time and prompt to save
if ($retval_edit == 0) {
$state->{kdb}->unlock; # Required for the password field
foreach my $key (keys %changes) { $ent->{$key} = $changes{$key}; }
$state->{kdb}->lock;
$ent->{modified} = $state->{kdb}->now;
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
return 0;
} else {
# If the edit failed (or if the user hit ^C while in edit_gui), then
# remove the target entity that cli_copy() made.
my $ent_id=$ent->{id};
$state->{kdb}->delete_entry({ id => $ent_id });
refresh_state_all_paths();
$state->{kdb_has_changed}=0; # Should be back to how we started
return $retval_edit;
}
}
sub cli_show($$) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
# Users can provide a -f option to show the password. We use GetOptions
# to parse this command line, and $target holds that target.
my $target='';
my %opts=();
{
local @ARGV = @{$params->{args}};
my $result = &GetOptions(\%opts, 'f', 'a');
if (scalar(@ARGV) != 1) {
return -1;
}
$target = $ARGV[0];
}
my $ent=find_target_entity_by_number_or_path($target);
if (! defined($ent)) {
return -1;
}
print "\n";
if (defined($ent->{path})) {
print show_format("Path",$ent->{path}) . "\n";
}
# Unless -f is specified, we "hide" the password as red-on-red.
my $password = $state->{kdb}->locked_entry_password($ent);
if (! defined($opts{f})) {
$password = colored(['red on_red'], $password);
}
# Print the entry for the user
print
show_format("Title",$ent->{title}) . "\n" .
show_format("Uname",$ent->{username}) . "\n" .
show_format("Pass",$password) . "\n" .
show_format("URL",$ent->{url}) . "\n" .
show_format("Notes",$ent->{comment}) . "\n" .
($DEBUG ? show_format("ID",$ent->{id}) . "\n" : '');
# Tags were added to KeePass in v2.11 (*.kdbx)
if (defined($ent->{tags}) && length($ent->{tags})) {
print show_format("Tags", humanize_entry_tags($ent->{tags})) . "\n";
}
# Check for strings and file attachments in this entry
foreach my $key (qw(strings binary)) {
my $attachment = show_helper_files_strings($ent,{f=>1},$key);
#my $attachment = show_helper_files_strings($ent, \%opts, $key);
if (length($attachment)) { print $attachment; }
}
# If -a was given, tack on those details
if (defined($opts{a})) {
print
show_format("Icon#",$ent->{icon}) . "\n" .
show_format("Creat",$ent->{created}) . "\n" .
show_format("Modif",$ent->{modified}) . "\n";
if (defined($ent->{expires})) {
my $expires = $ent->{expires};
if (does_expire_never($state->{kdb_ver}, $ent)) {
$expires = 'Never';
}
print show_format("Xpire",$expires) . "\n";
}
}
print "\n";
print &Dumper($ent) . "\n" if ($DEBUG > 2);
}
# A helper function to display key/val pairs and file attachments.
# Note that strings (key/val pairs) and multiple attachments per
# entry only exist in KeePass 2.x (kdbx) files, while verions 1.x
# files (kdb) support only a single file attachment per entry.
sub show_helper_files_strings {
my $ent = shift @_;
my $opts = shift @_;
my $key = shift @_;
my $labels = {
'binary' => ['Atchm','File Attachments'],
'strings' => ['Strgs','String Values'],
};
my @atts=();
if (defined($ent->{$key}) && ref($ent->{$key}) eq 'HASH') {
foreach my $name (sort keys %{$ent->{$key}}) {
if ($key eq 'binary') {
push @atts, "$name (". int(length($ent->{$key}->{$name})) ." bytes)";
} elsif ($key eq 'strings') {
if (defined($opts->{f})) {
push @atts, "$name = " . $ent->{$key}->{$name};
} else {
push @atts, "$name = ".colored(['red on_red'],$ent->{$key}->{$name});
}
}
}
}
my $attachment = '';
my $label = $labels->{$key}[0];
if (scalar(@atts) == 0 && defined($opts->{v})) {
$attachment = "None";
} elsif (scalar(@atts) == 1) {
$attachment = $atts[0];
} elsif (scalar(@atts) > 1) {
$label = $labels->{$key}[1];
my @t=();
foreach my $num (1..scalar(@atts)) {
push(@t, sprintf("%2d) %s", $num, $atts[$num-1]));
}
$attachment = "\n " . join("\n ", @t) . "\n";
}
return ($attachment ne '' ? show_format($label,$attachment) . "\n" : '');
}
sub cli_edit {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
my $target = $params->{args}->[0];
my $ent=find_target_entity_by_number_or_path($target);
if (! defined($ent)) {
print "Don't see an entry at path: $target\n";
return -1;
}
# Protect users from editing in the $FOUND_DIR.
my $ent_path = $state->{all_ent_paths_rev}->{$ent->{id}};
if ($ent_path =~ m/^\Q$FOUND_DIR\E/) {
print color('yellow')
. "That entity is in the temporary /$FOUND_DIR dir.\n"
. color('clear');
my $real_path = $ent->{full_path};
my $real_ent = find_target_entity_by_number_or_path($real_path);
if (defined($real_ent)) {
print "Would you rather edit $real_path? [y/N]";
my $key=get_single_key();
print "\n";
if (lc($key) eq 'y') {
$ent = $real_ent;
}
}
}
my %changes = ();
my $retval = _entry_edit_gui($ent, \%changes, $state->{kdb_ver});
# If the user made changes, apply them, update modify time and prompt to save
if ($retval == 0 && scalar(keys(%changes)) > 0) {
# Recycle the entry unless --no-recycle
if (! (defined($opts->{'no-recycle'}) && int($opts->{'no-recycle'}))) {
my $errmsg = recycle_entry($state, $ent);
if (defined($errmsg)) { print "WARNING: $errmsg\n"; }
}
# Update the entry's changed fields
$state->{kdb}->unlock; # Required for the password field
foreach my $key (keys %changes) { $ent->{$key} = $changes{$key}; }
$state->{kdb}->lock;
$ent->{modified} = $state->{kdb}->now;
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
}
return 0;
}
# A routine to copy entries to the /Backup or "/Recycle Bin" folders.
# Used by cli_edit, cli_rm, etc.
sub recycle_entry {
my $state = shift @_;
my $ent = shift @_;
my $bugrp_id = get_recycle_group_path($state, 1);
if (defined($bugrp_id)) {
$state->{kdb}->unlock; # Required for the password field
my $tmp_ent = clone($ent); # Clone the entity and back it up
delete $tmp_ent->{id};
# Append the modified time to the title for the backup dir
$tmp_ent->{title} = $tmp_ent->{title} . " (". $tmp_ent->{modified} .")";
$tmp_ent->{group} = $bugrp_id;
$tmp_ent->{modified} = $state->{kdb}->now;
my $add_result = $state->{kdb}->add_entry($tmp_ent);
$state->{kdb}->lock;
if (! $add_result) {
return "Failed to copy the entry to the backup folder.";
} else {
$state->{kdb_has_changed}=1;
}
refresh_state_all_paths();
}
return undef;
}
# Returns /Backup or "/Recycle Bin" based on KeePass v1 or v2 file.
# Creates the group if it is missing and $create_if_missing in true.
sub get_recycle_group_path {
my $state = shift @_;
my $create_if_missing = shift @_ || 0;
my $bugrp = "/Backup"; # Default to v1 (is this correct?)
if ($state->{kdb_ver} == 2) {
$bugrp = "/Recycle Bin";
}
my $grp_path = normalize_path_string($bugrp);
if ($create_if_missing) {
if (! defined($state->{all_grp_paths_fwd}->{$grp_path})) {
my $group = $state->{kdb}->add_group({
title => $grp_path,
icon => $DEfAULT_BAKUP_ICON,
}); # root level group
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
}
}
if (! defined($state->{all_grp_paths_fwd}->{$grp_path})) {
return undef;
}
return $state->{all_grp_paths_fwd}->{$grp_path};
}
# Helper function for cli_edit() and cli_clone()
sub _entry_edit_gui($$$) {
my $ent=shift @_;
my $rChanges = shift @_;
my $kdb_ver = shift @_;
# Loop through the fields taking edits the user wants to make
my @fields = get_entry_fields($kdb_ver);
foreach my $input (@fields) {
my $current_val = $ent->{$input->{key}};
my $val = '';
if (defined($input->{user_prep_func})) {
$current_val = $input->{user_prep_func}($current_val);
}
if (defined($input->{user_edit_func})) {
$val = $input->{user_edit_func}($ent, $input, $current_val);
} elsif ($input->{multiline}) {
$val = new_edit_multiline_input($input, $current_val);
} else {
$val = new_edit_single_line_input($input, $current_val);
}
# If the user hit ^C (SIGINT) then we need to stop
if (recent_sigint()) { return -1; }
# Call the validate_func if it's defined
if (defined($input->{validate_func}) && length($val)) {
# Note that $val can be modified by the validate_func
if ($input->{validate_func}(\$val) != 0) {
print "Invalid $input->{txt} input.\n";
return -1;
}
}
# Check a new title for same-name conflicts in its group
if ($input->{key} eq 'title' && length($val)) {
if ($val =~ m/\//) {
print "kpcli cannot support titles with slashes (/) in them.\n";
return -1;
}
my $path = $ent->{path}; # The group's path of the entry we are editing
my $new_entry = normalize_path_string("$path/$val");
if (defined($state->{all_ent_paths_fwd}->{$new_entry})) {
print "An entry titled \"$val\" is already in $path.\n";
return -1;
}
}
# If the field was not empty, we'll change it to the new $val
if (length($val)) { $rChanges->{$input->{key}} = $val; }
}
return 0;
}
# A code-consolidation function...
sub get_prepped_readline_term() {
our $state;
# Note: A 2nd Term::ReadLine::Gnu->new() just returns the same
# object as the one that Term::ShellUI is already using. With
# Term::Readline::Perl, an attempt to call new a 2nd time results
# in having a Term::Readline::Stub returned and a warning printed to
# STDERR, which we also don't want, and so I coded this the way that
# I did to make clear what is being done, and this comment for why.
my $term = $state->{term}->{term}; # Term::ShellUI's readline
$state->{active_readline} = $term;
# Use Term::ReadLine::Gnu more advanced functionality...
if ($term->ReadLine() eq 'Term::ReadLine::Gnu') {
# Called roughly 10-times per second while Gnu readline waits for input
$term->Attribs->{event_hook} = sub {
if (recent_sigint()) {
$term->Attribs->{event_hook} = undef;
$term->set_prompt('');
$term->Attribs->{line_buffer}='';
$term->Attribs->{done} = 1;
$state->{active_readline} = undef;
}
};
}
return $term;
}
# A helper function to interactively edit an entry's strings
sub edit_entry_strings {
my $ent = shift @_;
my $input = shift @_;
my $initial_value = shift @_;
our $state;
my $tmp_ent = clone($ent); # Clone the entity
EDIT_INTERFACE: while (1) {
my @strings_keys = ();
if (defined($tmp_ent->{strings}) && ref($tmp_ent->{strings}) eq 'HASH') {
@strings_keys = sort keys %{$tmp_ent->{strings}};
}
my $strings_count = scalar(@strings_keys);
my $t='';
my $prompt = "Strings";
if ($strings_count > 0) {
$t .= show_helper_files_strings($tmp_ent,{f=>1,v=>1},'strings');
$prompt = "Choose";
}
$t .= "$prompt: (a)dd/(e)dit/(d)elete/(c)ancel/(F)inish? ";
print "$t";
COMMAND: while (my $key=get_single_key()) {
if (lc($key) eq 'c' || ord($key) == 3) { # Cancel or ^C
print "\n";
return ''; # We are to return nothing on no change
} elsif ($key =~ m/^[fF\r\n]$/) { # Finished (save)
print "\n";
return $tmp_ent->{strings};
} elsif (lc($key) eq 'd') {
if (defined($tmp_ent->{strings}) &&
ref($tmp_ent->{strings}) eq 'HASH') {
if ($strings_count < 2) {
%{$tmp_ent->{strings}} = ();
} else {
print "\r". " "x60 ."\rWhich entry number do you want to delete? ";
my $choice = get_single_line();
if ($choice !~ m/^\d+$/ || $choice<1 || $choice > $strings_count) {
print "\nInvalid number.";
} else {
delete($tmp_ent->{strings}->{$strings_keys[$choice-1]});
}
}
print "\n";
next EDIT_INTERFACE;
}
} elsif (lc($key) =~ m/^[ae]$/) {
my $iv='';
my $fld_being_edited = undef;
if (lc($key) eq 'e') {
print "\r". " "x60 ."\rWhich entry number do you want to edit? ";
my $choice = get_single_line();
if ($choice !~ m/^\d+$/ || $choice<1 || $choice > $strings_count) {
print "\nInvalid number.";
print "\n";
next EDIT_INTERFACE;
}
$fld_being_edited = $strings_keys[$choice-1];
my $val_being_edited = $tmp_ent->{strings}->{$fld_being_edited};
$iv = "$fld_being_edited = $val_being_edited";
}
my $prompt = "Input a key=value pair: ";
print "\r". " "x60 ."\r";
my $term = get_prepped_readline_term();
my $keyval = $term->readline($prompt, $iv);
#my $keyval = get_single_line();
if ($keyval =~ m/^\s*([^=]+?)\s*=\s*(.+?)\s*$/) {
my ($fld, $val) = ($1, $2);
if (!(defined($tmp_ent->{strings})) &&
ref($tmp_ent->{strings}) eq 'HASH') {
$tmp_ent->{strings} = {};
}
if (defined($tmp_ent->{strings}->{$fld}) &&
(lc($key) eq 'a' || $fld ne $fld_being_edited)) {
print "\nString field \"$fld\" already exists in the entry.";
} else {
$tmp_ent->{strings}->{$fld}=$val;
if (defined($fld_being_edited) && $fld ne $fld_being_edited) {
delete($tmp_ent->{strings}->{$fld_being_edited});
}
}
} else {
print "\nInvalid entry.";
}
print "\n";
next EDIT_INTERFACE;
} else {
# Do nothing on invalid input
next COMMAND;
}
}
}
return $initial_value;
}
# Single line input helper function for cli_new and cli_edit.
sub new_edit_single_line_input($$) {
my $input = shift @_;
my $initial_value = shift @_;
our $state;
my $iv = ''; if (! $input->{hide_entry}) { $iv = $initial_value; }
my $term = get_prepped_readline_term();
my $val = '';
PASSWD_COLLECTION: {
if ($input->{genpasswd}) {
print " "x25 .'("g" or "w" to auto-generate, "i" for interactive)'. "\r";
}
my $prompt=$input->{txt} . ': ';
if ($input->{hide_entry}) {
$val = GetPassword($prompt, '');
} else {
$val = $term->readline($prompt, $iv);
}
chomp $val;
if ($input->{genpasswd} && $val =~ m/^([wgi])(\d*)$/) {
my $cmd = $1;
my $len = $2;
if ($cmd eq 'g' || $cmd eq 'i') {
if (!$len) {
$len = $DEFAULT_PASSWD_LEN;
} elsif ($len !~ m/^\d+$/ ||
$len < $DEFAULT_PASSWD_MIN || $len > $DEFAULT_PASSWD_MAX) {
$len = $DEFAULT_PASSWD_LEN;
print color('yellow')
. "Password length out of bounds, reset to $len chars.\n"
. color('clear');
}
if ($cmd eq 'g') {
$val = generatePasswordGobbledygook($len);
} elsif ($cmd eq 'i') {
$val = generatePasswordInteractive($len);
# Interactive canceled by user
if (! defined($val)) {
print "\n";
redo PASSWD_COLLECTION;
}
}
} elsif ($cmd eq 'w') {
$val = generatePassword();
} else {
die "BUG: it should be impossible to get to this code!\n";
}
} elsif (length($val) && $input->{double_entry_verify}) {
my $prompt = "Retype to verify: ";
my $checkval = '';
if ($input->{hide_entry}) {
$checkval = GetPassword($prompt, '');
} else {
$checkval = $term->readline($prompt);
}
# If the user hit ^C (SIGINT) then we need to stop
if (recent_sigint()) { return undef; }
chomp $checkval;
if ($checkval ne $val) {
print "Entries mismatched. Please try again.\n";
redo PASSWD_COLLECTION;
}
}
}
# We are done with readline calls so let's cleanup.
if ($term->ReadLine() eq 'Term::ReadLine::Gnu') {
$term->Attribs->{startup_hook} = undef;
$term->Attribs->{event_hook} = undef;
}
# This funciton is supposed to return blank if nothing changed
if ($val eq $initial_value) { $val = ''; }
return $val;
}
# Multi-line input helper function for cli_new and cli_edit.
sub new_edit_multiline_input($$) {
my $input = shift @_;
my $initial_value = shift @_;
our $state;
# Protect programmers from accidentally misusing this function
if ($input->{genpasswd}) { die "genpasswd unsupported by this function"; }
if ($input->{hide_entry}) {
print $input->{txt} . ": ";
} else {
my $mlval = $initial_value;
if ($mlval =~ m/\r|\n/) { $mlval = "\n$mlval\n"; }
print $input->{txt} . " (\"".$mlval."\"): ";
}
my $yellow=color('yellow');
my $clear=color('clear');
print "\n$yellow(end multi-line input with a single \".\" on a line)$clear\n";
my $term = get_prepped_readline_term();
my $val = ''; my $unfinished = 1;
while ($unfinished) {
# Term::ReadLine::Perl seems to have a bug that requires a prompt
# (it borks on ''), but after adding the pipe I liked it so left
# it place for all readlines.
my $line = $term->readline('| ');
if ($line =~ m/^\.[\r\n]*$/) { # a lone "." ends our input
$unfinished = 0;
} else {
$val .= $line;
$val .= "\n" if ($val !~ m/\n$/); # ReadLine() vs. $term->readline().
if ($val =~ m/^[\r\n]*$/) { $val = ''; $unfinished = 0; }
}
# If the user hit ^C (SIGINT) then we need to stop
if (recent_sigint()) { return undef; }
}
chomp($val); # Remove extra line at the end
return $val;
}
# Formats an entry for display for cli_show()
sub show_format($$) {
my $title=shift @_;
my $value=shift @_;
my $val=$value;
if ($val =~ m/\n/) {
my @val_lines=split(/\n/, $val);
$val=join("\n" . " "x(5+2), @val_lines);
}
return sprintf("%5s: %s", $title,$val);
}
# Formats a statistic display for cli_stats()
sub stats_print($) {
my $stats_r = shift @_;
my $max_key_len = 0;
my $max_val_len = 0;
foreach my $k (keys(%{$stats_r})) {
if (length($k) > $max_key_len) { $max_key_len = length($k); }
}
foreach my $k (values(%{$stats_r})) {
if (length($k) > $max_val_len) { $max_val_len = length($k); }
}
my $sprintf_format = " - %$max_key_len" . "s: %$max_val_len" . "d\n";
my $t='';
foreach my $stat_key (sort {$a <=> $b} keys %{$stats_r}) {
$t .= sprintf($sprintf_format, $stat_key, $stats_r->{$stat_key});
}
return $t;
}
# Helper functions to normalize and humanize entry tags
sub normalize_entry_tags {
my $rTagline = shift @_;
my @tags = split(/\s*[;,]\s*/, $$rTagline);
$$rTagline = join(';', @tags);
return 0;
}
sub humanize_entry_tags {
my $tagline = shift @_;
my @tags = split(/\s*[;,]\s*/, $tagline);
return join(', ', @tags);
}
# Function to return a data structure to support adding/editing entries
sub get_entry_fields {
my $kdb_ver = shift @_ || 1; # *.kdb or *.kdbx (v1 or v2)
my @fields = (
{ key=>'title', txt=>'Title' },
{ key=>'username', txt=>'Username' },
{ key=>'password', txt=>'Password',
hide_entry => 1, double_entry_verify => 1, genpasswd => 1 },
{ key=>'url', txt=>'URL' },
);
# We only want "tags" if we are dealing with a v2 file (*.kdbx)
if ($kdb_ver == 2) {
push @fields, (
{ key=>'tags', txt=>'Tags', 'multiline' => 0,
user_prep_func => \&humanize_entry_tags,
validate_func => \&normalize_entry_tags,
},
{ key=>'strings', txt=>'Strgs',
user_edit_func => \&edit_entry_strings,
},
);
}
push @fields, (
{ key=>'comment', txt=>'Notes/Comments', 'multiline' => 1 },
);
return @fields;
}
# Code consolidation function.
# Returns true if $state->{signals}->{INT} indicates a SIGINT more
# recently than the $timeframe given, which defaults to 0.25 secs.
sub recent_sigint() {
my $timeframe = shift @_;
if ($timeframe !~ m/^([0-9]*\.[0-9]+|[0-9]+)$/) { $timeframe = 0.25; }
our $state;
if (defined($state->{signals}->{INT}) &&
tv_interval($state->{signals}->{INT}) < $timeframe) {
return 1;
}
return 0;
}
sub cli_icons($) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
print "Change icons on Groups or Entries (g/e/Cancel)? ";
my $groups_or_entries=lc(get_single_key());
print "\n";
if (recent_sigint() || $groups_or_entries !~ m/^[ge]$/) { return; }
print "Change icons Here, Below here, or Globally (h/b/g/Cancel)? ";
my $glob_or_rel=lc(get_single_key());
print "\n";
if (recent_sigint() || $glob_or_rel !~ m/^[hgb]$/) { return; }
print "What would you line the new icon to be (0-64/Cancel)? ";
my $term = get_prepped_readline_term();
my $val = $term->readline('');
# If the user hit ^C (SIGINT) then we need to stop
if (recent_sigint()) { return undef; }
chomp($val);
if ($val !~ m/^[0-9]+$/ || $val < 0 || $val > 64) {
print "Invalid icon number.\n";
return;
}
# This code fills @{$groups} or @{$entries} with the items that the
# user wants to change the icons on.
my ($groups,$entries) = ([],[]);
if ($glob_or_rel eq 'h') { # "Here" is easy -- we have a function for that.
($groups,$entries) = get_current_groups_and_entries();
if ($groups_or_entries eq 'e') {
$groups = [];
} else {
$entries = [];
}
} else {
if ($glob_or_rel eq 'g') { # Globally is easy, it's all groups
my $k=$state->{kdb};
@{$groups} = $k->find_groups({});
} elsif ($glob_or_rel eq 'b') {
my $id=$state->{path}->{id};
@{$groups} = all_child_groups_flattened($id); # *only child groups*
} else {
warn "WHAT? Should never get to this piece of code!\n";
}
# If the user wanted to operate on entries, collect all the entries
# in the @{$groups} and then empty @{$groups}.
if ($groups_or_entries eq 'e') {
foreach my $group (@{$groups}) {
if (defined($group->{entries})) {
push @{$entries}, @{$group->{entries}};
}
}
$groups = [];
}
}
# Change the items, recording the number of changes.
my $items_changed=0;
foreach my $item (@{$groups}, @{$entries}) {
$item->{icon} = $val;
$items_changed++;
}
# Tell the user what we did.
print "The icon value was set to $val on $items_changed records.\n";
# If we changed anything, ask the user if they want to save
if ($items_changed > 0) {
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
}
return 0;
}
sub cli_new($) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
my $new_path=get_pwd();
my $new_title='';
# If the user gave us a path (that may include the new title) in args[0],
# then we have to first rationalize that path.
if (defined($params->{args}->[0])) {
$new_path = $params->{args}->[0];
# Insure that $new_path is absolute
if ($new_path !~ m/^\/+$/) {
$new_path = get_pwd() . '/' . $new_path;
}
my $norm_path = normalize_path_string($new_path);
my ($grp_path,$name)=normalize_and_split_raw_path($new_path);
if (defined($state->{all_grp_paths_fwd}->{$norm_path})) {
$new_path = '/' . humanize_path($norm_path);
$new_title = '';
} elsif (defined($state->{all_grp_paths_fwd}->{$grp_path})) {
$new_path = '/' . humanize_path($grp_path);
$new_title = $name;
} else {
if ($norm_path eq '') {
print "Entries cannot be made in the root path.\n";
} else {
print "Bad path for new entry\n";
}
return;
}
}
# $id needs to be set to the ID of the group we want to add to
my $id = undef;
my $norm_path=normalize_path_string($new_path);
if (defined($state->{all_grp_paths_fwd}->{$norm_path})) {
$id=$state->{all_grp_paths_fwd}->{$norm_path};
}
# Make sure that we have a valid path for creating a new entry
if ($new_path =~ m/^\/+$/ || (! defined($id))) {
print "Entries cannot be made in this path ($new_path).\n";
return -1;
}
print "Adding new entry to \"$new_path\"\n";
# Grab the entries at this $id (pwd) so we can check for conflicts
my $k=$state->{kdb};
my ($this_grp,@trash) = $k->find_groups({id=>$id});
my @entries = $k->find_entries({group_id => $id});
my $new_entry = {
'group' => $id,
};
my @fields = get_entry_fields($state->{kdb_ver});
NEW_DATA_COLLECTION: foreach my $input (@fields) {
my $val = '';
if (defined($input->{user_edit_func})) {
$val = $input->{user_edit_func}($new_entry, $input, {});
# An empty hash-ref is "empty/blank" for strings, but the
# user_edit_func returns the scalar '' in that case.
if ($input->{key} eq 'strings' && ref($val) ne 'HASH') { $val = {}; }
} elsif ($input->{multiline}) {
$val = new_edit_multiline_input($input, '');
} else {
if ($new_title ne '' && $input->{key} eq 'title') {
print $input->{txt} . ": $new_title\n";
$val = $new_title;
} else {
$val = new_edit_single_line_input($input, '');
}
}
# If the user hit ^C, abort the new entry
if (recent_sigint()) { return undef; }
# If the user gave us an empty title, abort the new entry
if ($input->{key} eq 'title' && length($val) == 0) { return undef; }
# Call the validate_func if it's defined
if (defined($input->{validate_func}) && length($val)) {
# Note that $val can be modified by the validate_func
if ($input->{validate_func}(\$val) != 0) {
print "Invalid $input->{txt} input.\n";
return -1;
}
}
# Check the new title for same-name conflicts in its group
if ($input->{key} eq 'title') {
if ($val =~ m/\//) {
print "kpcli cannot support titles with slashes (/) in them.\n";
return undef;
}
my $new_entry = normalize_path_string($new_path . '/' . $val);
if (defined($state->{all_ent_paths_fwd}->{$new_entry})) {
print "An entry titled \"$val\" is already in $new_path.\n";
return undef;
}
}
$new_entry->{$input->{key}} = $val;
}
$new_entry->{icon} = $DEFAULT_ENTRY_ICON;
$k->unlock;
my $new_entry_ref = $k->add_entry($new_entry);
$k->lock;
if ($new_entry_ref->{id}) {
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
} else {
print "Failed to add new entry.\n";
}
return 0;
}
sub cli_import {
my $file=shift @_;
my $new_group_path=shift @_;
my $key_file=shift @_;
our $state;
if (recent_sigint() || deny_if_readonly()) { return; }
# If the user gave us a bogus file there's nothing to do
if (! -f ($file)) {
print "File does not exist: $file\n";
return -1;
}
my $import_file_type = magic_file_type($file);
if (scalar(grep(/^$import_file_type$/, qw(keepass pws3))) != 1) {
print "Does not appear to be a KeePass or Password Safe v3 file: $file\n";
return -1;
}
# If the $new_group_path is a relative path, make it absolute
if ($new_group_path !~ m/^\//) {
$new_group_path = get_pwd() . "/$new_group_path";
}
# We won't import into an existing group
my $full_path=normalize_path_string($new_group_path);
if (defined($state->{all_grp_paths_fwd}->{$full_path})) {
print "You must specify a _new_ group to import into.\n";
return -1;
}
# Make sure the new group's parent exists
my ($grp_path,$grp_name)=normalize_and_split_raw_path($new_group_path);
if ($grp_path != '' && ! defined($state->{all_grp_paths_fwd}->{$grp_path})) {
print "Path does not exist: /" . humanize_path($grp_path) . "\n";
return -1;
}
# Set the $parent_group value appropriately
my $parent_group = undef; # Root by default
if (length($grp_path)) {
$parent_group = $state->{all_grp_paths_fwd}->{$grp_path};
}
# Ask the user for the master password and then open the kdb
my $master_pass=GetMasterPasswd();
if (recent_sigint()) { return undef; } # Bail on SIGINT
if ($import_file_type eq 'keepass') {
return cli_import_keepass($file,
$master_pass,$key_file,$grp_name,$parent_group);
} elsif ($import_file_type eq 'pws3') {
return cli_import_pwsafe3($file,
$master_pass,$key_file,$grp_name,$parent_group);
} else {
print "Unsupported file type for import.\n";
return -1;
}
}
sub cli_import_pwsafe3 {
my $file = shift @_;
my $master_pass = shift @_;
my $key_file = shift @_;
my $grp_name = shift @_;
my $parent_group = shift @_;
our $state;
# This requires Crypt::PWSafe3 so try to load it if we don't have it
if (! $state->{OPTIONAL_PM}->{'Crypt::PWSafe3'}->{loaded}) {
runtime_load_module(\%OPTIONAL_PM,'Crypt::PWSafe3',[qw(capture)]);
}
if (! $state->{OPTIONAL_PM}->{'Crypt::PWSafe3'}->{loaded}) {
print "Perl module Crypt::PWSafe3 is required for this functionality.\n";
return -1;
}
# The eval is needed to catch the output of Carp::croak from Crypt::PWSafe3
my $pws3;
eval { $pws3 = new Crypt::PWSafe3(file => $file,
password => $master_pass, program => $APP_NAME); };
if ($@ || ref($pws3) ne 'Crypt::PWSafe3') {
print "Failed to load $file.";
if ($@ =~ m/^Wrong password/i) {
print " Wrong password.\n";
} else {
print "Error: $@\n";
}
return -1;
}
my @records = $pws3->getrecords();
if (scalar(@records) < 1) { print "No records to import.\n"; return -1; }
# Find any groups in the pws3 file that we need to create, and make them
my @groups = ();
foreach my $record (@records) { push @groups, $record->group(); }
@groups = grep(!/^$/, @groups); # eliminate the top-level (empty) group
# Add the new group, to its parent or to root if $parent_group==undef
my $k=$state->{kdb};
my $new_group=$k->add_group({
title => $grp_name,
group => $parent_group,
});
# %new_groups will hold new groups that we add during this import,
# indexed by the PWSafe3 group name, like "foo.bar.baz"
my %new_groups = ();
$new_groups{""} = $new_group; # Top level group for this import
@groups = sort(uniq(@groups)); # sort is critical to the algorithm just below
#print "LHHD: " . &Dumper(\@groups) . "\n";
foreach my $group (@groups) {
my @group_tree = split(/[.]/, $group);
#print "LHHD: " . &Dumper(\@group_tree) . "\n";
my $child_group = pop @group_tree;
my $new_group_pws3_path = join(".", @group_tree);
my $pws3_parent_group = $new_group; # default to new parent group
if (defined($new_groups{$new_group_pws3_path})) {
$pws3_parent_group = $new_groups{$new_group_pws3_path};
}
#print "LHHD: need2make *$child_group* under *$new_group_pws3_path*\n";
#print "LHHD: creating $child_group under $pws3_parent_group\n";
$new_groups{$group}=$k->add_group({
title => $child_group,
group => $pws3_parent_group,
});
}
# The new group(s) are made, now insert the records...
$k->unlock();
foreach my $record (@records) {
my $pws3_group = $record->group();
my $new_entry = {
'group' => $new_groups{$pws3_group},
'title' => $record->title(),
'username' => $record->user(),
'password' => $record->passwd(),
'comment' => $record->notes(),
'url' => $record->url(),
'created' => strftime("%Y-%m-%d %H:%M:%S",localtime($record->ctime())),
'modified' => strftime("%Y-%m-%d %H:%M:%S",localtime($record->mtime())),
'accessed' => strftime("%Y-%m-%d %H:%M:%S",localtime($record->atime())),
'expires' => strftime("%Y-%m-%d %H:%M:%S",localtime($record->pwexp())),
};
$k->add_entry($new_entry);
#print "LHHD: " . &Dumper($record) . "\n";
}
$k->lock();
# Refresh all paths and mark state as changed
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
}
sub cli_import_keepass {
my $file = shift @_;
my $master_pass = shift @_;
my $key_file = shift @_;
my $grp_name = shift @_;
my $parent_group = shift @_;
our $state;
my $iKDB = File::KeePass->new;
if (! eval { $iKDB->load_db($file,
composite_master_pass($master_pass, $key_file)) }) {
print "Couldn't load the file $file: $@\n";
return -1;
}
# Add the new group, to its parent or to root if $parent_group==undef
my $k=$state->{kdb};
my $new_group=$k->add_group({
title => $grp_name,
group => $parent_group,
});
# Copy the $iKDB into our $k at $new_group
$iKDB->unlock();
$k->unlock();
my @root_groups = $iKDB->find_groups({level=>0});
foreach my $i_root_grp (@root_groups) {
copy_kdb_group_tree($k,$i_root_grp,$new_group);
}
$k->lock();
$iKDB->lock();
$iKDB=undef;
# Refresh all paths and mark state as changed
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
}
sub cli_export($$) {
my $file=shift @_;
my $key_file=shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
# Warn is we are being asked to overwrite a file
if (-e $file) {
print "WARNING: $file already exists.\n" .
"Overwrite it? [y/N] ";
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
return -1;
}
}
# Ask if the key file should be generated, if it doesn't exist
my $make_keyfile=0;
if (defined($key_file) && (! -f $key_file)) {
print "Your specified key file does not exist. Generate it? [y/N] ";
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
return -1;
}
$make_keyfile=1;
if (recent_sigint()) { return undef; } # Bail on SIGINT
}
# Get the master password for the exported file
my $master_pass=GetMasterPasswdDoubleEntryVerify();
if (recent_sigint()) { return undef; } # Bail on SIGINT
if (! defined($master_pass)) { return undef; }
if (length($master_pass) == 0) {
print "For your safety, empty passwords are not allowed...\n";
return;
}
# Generate the key file if so instructed
if (defined($key_file) && $make_keyfile) {
my $fh=new FileHandle;
if (! open($fh,'>',$key_file)) {
print "ERROR: Could not open key file for writing: $key_file\n";
return -1;
}
my $KEYFILE_SIZE = 2048;
print $fh generateKeyfileContents($KEYFILE_SIZE);
close($fh);
my $size = (stat($key_file))[7];
if ($size != $KEYFILE_SIZE) {
print "ERROR: generated key file is the wrong size: $key_file\n";
return -1;
}
}
# Build the new kdb in RAM
my $k=$state->{kdb};
my $new_kdb=new File::KeePass;
$k->unlock; # Required so that we can copy the passwords
if (get_pwd() ne '/') {
# Grab the root group's $id at our pwd
my $pwd_group_id=$state->{path}->{id};
my ($root_grp,@trash) = $k->find_groups({id=>$pwd_group_id});
copy_kdb_group_tree($new_kdb,$root_grp,undef);
} else {
# Put all of the root groups into the new file (entire file copy)
my @root_groups = $k->find_groups({level=>0});
foreach my $root_grp (@root_groups) {
copy_kdb_group_tree($new_kdb,$root_grp,undef);
}
}
$k->lock;
$new_kdb->unlock;
my $new_db_bin =
$new_kdb->gen_db(composite_master_pass($master_pass,$key_file));
$new_kdb->lock;
# Test parsing the kdb from RAM (we'll most likely die if this fails)
my $new_db=new File::KeePass;
$new_db->parse_db($new_db_bin,composite_master_pass($master_pass,$key_file));
# Now write the new kdb to disk
my $fh=new FileHandle;
if (open($fh,'>',$file)) {
print $fh $new_db_bin;
close $fh;
print "Exported to $file\n";
} else {
print "Could not open \"$file\" for writing.\n";
}
return 0;
}
# A helper function for cli_export() and cli_import(). It takes a kdb object,
# a group as a starting point to copy from, and optionally a parent_group to
# copy to. It copies everything from the source group's root downward. In our
# use cases, the _target_ $kdb object passed in here is typically a different
# one than the _source_ $group is from.
sub copy_kdb_group_tree {
my $kdb=shift @_;
my $group=shift @_;
my $parent_group=shift @_ || undef; # When undef, it writes to the root
# Add the new group, to it's parent or root if $parent_group==undef
my $new_group=$kdb->add_group({
title => $group->{title},
icon => $group->{icon},
id => $group->{id},
group => $parent_group,
});
# Add the new_group's entries
if (ref($group->{entries}) eq 'ARRAY') {
foreach my $entry (@{$group->{entries}}) {
$entry->{group} = $new_group;
$kdb->add_entry($entry);
}
}
# Add the new_group's child groups
if (ref($group->{groups}) eq 'ARRAY') {
foreach my $child_grp (@{$group->{groups}}) {
copy_kdb_group_tree($kdb,$child_grp,$new_group);
}
}
}
sub cli_saveas($) {
my $file=shift @_;
my $key_file=shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
# If the user has asked for a *.kdbx file, check the File::KeePass version
if (version->parse($File::KeePass::VERSION) < version->parse('2.03')) {
if ($file =~ m/\.kdbx$/i) {
print "KeePass v2 (*.kdbx files) require File::KeePass >= v2.03\n";
return;
}
}
# Warn is we are being asked to overwrite a file
if (-e $file) {
print "WARNING: $file already exists.\n" .
"Overwrite it? [y/N] ";
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
return -1;
}
if (recent_sigint()) { return undef; } # Bail on SIGINT
}
# Ask if the key file should be generated, if it doesn't exist
my $make_keyfile=0;
if (defined($key_file) && (! -f $key_file)) {
print "Your specified key file does not exist. Generate it? [y/N] ";
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
return -1;
}
$make_keyfile=1;
if (recent_sigint()) { return undef; } # Bail on SIGINT
}
# Get the master password for the file
my $master_pass=GetMasterPasswdDoubleEntryVerify();
if (recent_sigint()) { return undef; } # Bail on SIGINT
if (! defined($master_pass)) { return undef; }
if (length($master_pass) == 0) {
print "For your safety, empty passwords are not allowed...\n";
return;
}
# Generate the key file if so instructed
if (defined($key_file) && $make_keyfile) {
my $fh=new FileHandle;
if (! open($fh,'>',$key_file)) {
print "ERROR: Could not open key file for writing: $key_file\n";
return -1;
}
my $KEYFILE_SIZE = 2048;
print $fh generateKeyfileContents($KEYFILE_SIZE);
close($fh);
my $size = (stat($key_file))[7];
if ($size != $KEYFILE_SIZE) {
print "ERROR: generated key file is the wrong size: $key_file\n";
return -1;
}
}
destroy_found();
scrub_unknown_values_from_all_groups(); # TODO - remove later
$state->{kdb}->unlock;
$state->{kdb}->save_db($file,composite_master_pass($master_pass,$key_file));
$state->{kdb}->lock;
$state->{kdb}= File::KeePass->new;
if (! eval { $state->{kdb}->load_db($file,
composite_master_pass($master_pass,$key_file)) }) {
die "Couldn't load the file $file: $@";
}
# We hold a read file handle open for no reason other than
# to show up in lsof.
if (defined($state->{kdb_file_handle})) {
close $state->{kdb_file_handle};
}
$state->{kdb_file_handle} = new FileHandle;
open($state->{kdb_file_handle}, '<', $file);
$state->{kdb_file} = $file;
$state->{kdb_has_changed}=0;
$state->{kdb_file} = $file;
$state->{key_file} = $key_file;
$state->{put_master_passwd}($master_pass);
$master_pass="\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
return 0;
}
# This routine takes a raw (directly from user input) path string
# and "normalizes" it (converts it to NULL-separated w/out escapes)
# and splits it into its dirname and basename components.
sub normalize_and_split_raw_path($) {
my $raw_pathstr=shift @_;
my $path=normalize_path_string($raw_pathstr);
my $basename='';
if ($path =~ m/\0/) { # case of at least one path delimeter
$path =~ s/\0([^\0]+)$//;
$basename=$1;
} elsif ($raw_pathstr =~ m/^\//) { # case of simple "/foo" (no subdir)
$basename=$path;
$path='';
} else { # case of simple "foo" (no path delims)
$path = normalize_path_string(get_pwd());
$basename=$raw_pathstr;
}
return($path,$basename);
}
sub cli_rmdir($) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
my $raw_pathstr=$params->{'args'}->[0];
my ($path,$grp_name) = normalize_and_split_raw_path($raw_pathstr);
# Make sure the group exists.
my $grp_path="$path\0$grp_name";
$grp_path=~s/^\0+//;
if (! defined($state->{all_grp_paths_fwd}->{$grp_path})) {
print "Path does not exist: /" . humanize_path($grp_path) . "\n";
return -1;
}
my $group_id = $state->{all_grp_paths_fwd}->{$grp_path};
my $group = $state->{kdb}->find_group({ id => $group_id });
my @entries = ();
my $entry_cnt=0;
if (defined($group->{entries})) {
@entries = grep(m/^\Q$grp_path\E\0/,keys %{$state->{all_ent_paths_fwd}});
$entry_cnt = scalar(@entries);
}
my $group_cnt=0;
if (defined($group->{entries})) {
$group_cnt=
scalar(grep(m/^\Q$grp_path\E\0/,keys %{$state->{all_grp_paths_fwd}}));
}
my $child_cnt=$entry_cnt + $group_cnt;
if ( $child_cnt > 0) {
print "WARNING: This group has $child_cnt child groups and/or entries.\n" .
"Really remove it!? [y/N] ";
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
return -1;
}
}
# Recycle any entries that we're also removing
if ($entry_cnt > 0) {
if (! (defined($opts->{'no-recycle'}) && int($opts->{'no-recycle'}))) {
foreach my $ent_path (@entries) {
my $ent_id = $state->{all_ent_paths_fwd}->{$ent_path};
my $ent = $state->{kdb}->find_entry({id => $ent_id});
my $errmsg = recycle_entry($state, $ent);
if (defined($errmsg)) { print "WARNING: $errmsg\n"; }
}
}
}
# Delete the group, refresh our state paths, request save, etc.
my $deleted_group = $state->{kdb}->delete_group({ id => $group_id });
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
return 0;
}
sub cli_mkdir($) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
my $raw_pathstr = $params->{args}->[0];
my ($path,$newdir) = normalize_and_split_raw_path($raw_pathstr);
# Make sure the group doesn't already exist.
my $newdir_path="$path\0$newdir";
$newdir_path=~s/^\0+//;
if (defined($state->{all_grp_paths_fwd}->{$newdir_path})) {
print "Path already exists: /" . humanize_path($newdir_path) . "\n";
return -1;
}
# Create the group
my $group='';
if ($path eq '') {
$group = $state->{kdb}->add_group({
title => $newdir,
icon => $DEfAULT_GROUP_ICON,
}); # root level group
} elsif (defined($state->{all_grp_paths_fwd}->{$path})) {
my $group_id=$state->{all_grp_paths_fwd}->{$path};
$group = $state->{kdb}->add_group({
title => $newdir,
group => $group_id,
icon => $DEfAULT_GROUP_ICON,
});
} else {
print "Cannot make directory at path " . humanize_path($path) . "\n";
return -1;
}
# Because we created a new group we need to refresh ours state paths
refresh_state_all_paths();
$state->{kdb_has_changed}=1;
RequestSaveOnDBChange();
return 0;
}
sub humanize_path($) {
my $path=shift @_;
$path =~ s/\//\\\//g;
$path =~ s/\0/\//g;
return $path;
}
sub cli_open($) {
my $path=shift @_;
my $key=shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
# If cli_close() does not return 0 the user decided not to close the file
if (cli_close() != 0) {
return -1;
}
if ( -f $path ) {
my $err = open_kdb($path, $key);
if (length($err)) {
print "Error opening file: $err\n";
}
} else {
print "Cannot open: $path\n";
}
}
# Get a single keypress from the user
sub get_single_key {
my $drain_first = shift @_ || 1;
our $state;
my $key='';
$|=1; # Needed to flush STDOUT on Windows cmd prior to calling ReadMode
ReadMode('raw'); # Turn off controls keys
while($drain_first && defined( $key = ReadKey(-1) ) ) {} # Drain STDIN first
while (not defined ($key = ReadKey(-1))) {
# If the user hit ^C (SIGINT) then we need to stop
if (recent_sigint()) { return undef; }
# No key yet, but let's not eat 100% CPU while waiting, so sleep.
Time::HiRes::sleep(0.1);
}
ReadMode('restore');
return $key;
}
# Get a single line of input from the user
sub get_single_line {
our $state;
$|=1; # Needed to flush STDOUT on Windows cmd prior to calling ReadMode
my $input='';
while (1) {
my $c = get_single_key(0);
if (ord($c) == 3) { # ^C
return '';
} elsif (ord($c) == 127 || ord($c) == 8) { # backspace (Linux/Windows)
if (length($input) > 0) {
$input = substr($input,0,length($input) - 1);
print chr(8)." ".chr(8); # Erase a character
}
} elsif ($c =~ m/[\n\r]/) {
return $input;
} else {
$input.=$c;
print $c;
}
}
}
sub cli_close {
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
if ($state->{kdb_has_changed}) {
print "WARNING: The database has changed and was not saved.\n" .
"Really close it? [y/N] ";
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
return -1;
}
}
$state->{'kdb'}->clear();
new_kdb($state);
if (defined($state->{kdb_file_handle})) {
close $state->{kdb_file_handle};
}
return 0;
}
# This sets $state to a brand new, KeePassX-style, empty, unsaved database
sub new_kdb {
my $state=shift @_;
$state->{kdb_has_changed}=0;
$state->{'kdb'} = File::KeePass->new;
#$state->{kdb_ver} = $state->{kdb}->{header}->{version}; # undef after ->new()
$state->{kdb_ver} = 1; # Only provide 1.x (*.kdb) features by default
# To be compatible with KeePassX
$state->{'kdb'}->add_group({ title => 'eMail' });
$state->{'kdb'}->add_group({ title => 'Internet' });
refresh_state_all_paths();
if (-f $state->{placed_lock_file}) { unlink($state->{placed_lock_file}); }
delete($state->{placed_lock_file});
delete($state->{kdb_file});
delete($state->{key_file});
delete($state->{master_pass});
cli_cd($term, {'args' => ["/"]});
}
sub cli_ls {
my $self = shift @_;
my $params = shift @_;
our $state;
$state->{last_ls_ents} = []; # We reload this state in this function
if (recent_sigint()) { return undef; } # Bail on SIGINT
my @paths = ();
if (defined($params) && defined($params->{'args'}) &&
ref($params->{'args'}) eq 'ARRAY') {
@paths = @{$params->{'args'}};
}
if (scalar(@paths) == 0) { push @paths, get_pwd(); }
my $paths_count = scalar(@paths);
my @ent_matches = (); # Collects entries we've been directly asked to list
my @grp_paths = (); # Collects groups we've been asked to list
my $k=$state->{kdb};
foreach my $path (@paths) {
my $norm_path = normalize_path_string($path);
if (defined($state->{all_grp_paths_fwd}->{$norm_path}) || length($norm_path) < 1) {
push @grp_paths, $path;
} elsif (defined($state->{all_ent_paths_fwd}->{$norm_path})) {
my $tmp_ent = $k->find_entry({id=>$state->{all_ent_paths_fwd}->{$norm_path}});
push @ent_matches, $tmp_ent;
} else {
my @tmp_ents = shell_expansion($path);
foreach my $tmp_ent (@tmp_ents) {
if (defined($state->{all_ent_paths_fwd}->{$tmp_ent})) {
my $entry_id = $state->{all_ent_paths_fwd}->{$tmp_ent};
my $ent = $state->{kdb}->find_entry( {id=>$entry_id} );
push @ent_matches, $ent;
} elsif (defined($state->{all_grp_paths_fwd}->{$tmp_ent})) {
push @grp_paths, '/'.humanize_path($tmp_ent);
}
}
}
}
my $have_output=0; # Helps manage "\n" placements below.
# First present the entries that we were directly asked to list
if (scalar(@ent_matches) > 0) {
@ent_matches = sort { ncmp($a->{title},$b->{title}); } @ent_matches;
if ($have_output) { print "\n"; }
print "=== Entries ===\n";
print join("\n", @{get_human_entry_list(\@ent_matches, scalar(@{$state->{last_ls_ents}}))}) ."\n";
push @{$state->{last_ls_ents}}, @ent_matches;
$have_output++;
}
# Now present the groups that we were asked to list
foreach my $path (sort { ncmp($a,$b) } @grp_paths) {
my $norm_path = normalize_path_string($path);
if ($have_output) { print "\n"; }
if (scalar(@ent_matches) > 0 || scalar(@grp_paths) > 1) {
print "$path:\n";
$have_output++;
}
my @groups = (); my @entries = ();
if (length($norm_path) < 1) {
@groups = $k->find_groups({level=>0});
@entries = $k->find_entries({level => 0});
} else {
my $group_id = $state->{all_grp_paths_fwd}->{$norm_path};
@entries = $k->find_entries({group_id=>$group_id});
@entries = sort { ncmp($a->{title},$b->{title}); } @entries;
my $this_grp = $k->find_group({id=>$group_id});
if (defined($this_grp->{groups})) {
@groups = sort group_sort @{$this_grp->{groups}};
}
}
# Eliminate "system" entries inside this group that we don't want to show
my @good_entries = ();
MATCHES: foreach my $ent (@entries) {
#my $ent = $k->find_entry({id=>$state->{all_ent_paths_fwd}->{$match}});
if (defined($ent) && $ent->{'title'} eq 'Meta-Info' && $ent->{'username'} eq 'SYSTEM') {
next MATCHES;
}
push @good_entries, $ent;
}
@entries = @good_entries;
# Display the groups and entries that we have
if (scalar(@groups) > 0) {
print "=== Groups ===\n";
print join("\n", @{get_human_group_list(\@groups)}) . "\n";
$have_output++;
}
if (scalar(@entries) > 0) {
print "=== Entries ===\n";
print join("\n", @{get_human_entry_list(\@entries, scalar(@{$state->{last_ls_ents}}))}) . "\n";
$have_output++;
push @{$state->{last_ls_ents}}, @entries;
}
}
return 0;
}
# Helper function for cli_ls()
sub get_human_group_list($) {
my $rGroup=shift @_;
my @list=();
foreach my $grp (@{$rGroup}) {
#push (@list, sprintf("%15d %s/", $grp->{id}, $grp->{title}));
push (@list, "$grp->{title}/");
push (@list, &Dumper($grp)) if ($DEBUG > 2);
}
return \@list;
}
# Helper function for cli_ls()
sub get_human_entry_list {
my $rEntries=shift @_;
my $start_num = shift @_ || 0;
my @list=();
my $i=0;
my $d_len = length(scalar(@{$rEntries}) - 1 + $start_num);
foreach my $ent (@{$rEntries}) {
my $url=$ent->{url};
$url=~s/^https?:\/\///i;
$url=~s/\/+$//;
push (@list, sprintf("%".$d_len."d. %-40.40s %30.30s",
$i + $start_num, $ent->{title}, $url));
$i++;
}
return \@list;
}
# Routine to hook into Term::ShellUI's exit on Ctrl-D functionality
sub eof_exit_hook {
our $state;
# We need a newline if cli_quit() will talk tothe user about saving
if ($state->{kdb_has_changed}) { print "\n"; }
# cli_quit() will handle user interaction and return a value for
# the exit_hook of Term::ShellUI.
return cli_quit($state->{term},undef);
}
# Entry attachment handling
sub cli_attach {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint() || deny_if_readonly() || warn_if_file_changed()) {
return;
}
my $target = $params->{args}->[0];
my $ent=find_target_entity_by_number_or_path($target);
if (! defined($ent)) {
print "Don't see an entry at path: $target\n";
return -1;
}
my $tmp_ent = clone($ent); # Clone the entity
$state->{attach_changed} = 0;
ATTACH_INTERFACE: while (1) {
my @strings_keys = ();
if (defined($tmp_ent->{binary}) && ref($tmp_ent->{binary}) eq 'HASH') {
@strings_keys = sort keys %{$tmp_ent->{binary}};
}
my $strings_count = scalar(@strings_keys);
my $t='';
my $prompt = "Choose";
if ($strings_count > 0) {
$t .= show_helper_files_strings($tmp_ent,{f=>1,v=>1},'binary');
$t .= "$prompt: (a)dd/(e)xport/(d)elete/(c)ancel/(F)inish? ";
} else {
$t .= "No files attached.\n";
$t .= "$prompt: (a)dd/(c)ancel/(F)inish? ";
}
print "$t";
COMMAND: while (my $key=get_single_key()) {
if (lc($key) eq 'c' || ord($key) == 3) { # Cancel or ^C
print "\n";
delete $state->{attach_changed}; # Delete our temporary state var
return;
} elsif ($key =~ m/^[fF\r\n]$/) { # Finished (save)
print "\n";
$ent->{binary} = $tmp_ent->{binary};
if ($state->{attach_changed}) {
delete $state->{attach_changed}; # Delete our temporary state var
# Recycle the entry if changes were made unless --no-recycle
if (!(defined($opts->{'no-recycle'}) && int($opts->{'no-recycle'}))) {
my $errmsg = recycle_entry($state, $ent);
if (defined($errmsg)) { print "WARNING: $errmsg\n"; }
}
$state->{kdb_has_changed} = 1;
RequestSaveOnDBChange();
}
return;
} elsif (lc($key) eq 'd') {
if (defined($tmp_ent->{binary}) && ref($tmp_ent->{binary}) eq 'HASH') {
if ($strings_count < 2) {
%{$tmp_ent->{binary}} = ();
$state->{attach_changed}=1 if ($strings_count == 1);
} else {
print "\r". " "x60 ."\rWhich entry number do you want to delete? ";
my $choice = get_single_line();
if ($choice !~ m/^\d+$/ || $choice<1 || $choice > $strings_count) {
print "\nInvalid number.";
} else {
delete($tmp_ent->{binary}->{$strings_keys[$choice-1]});
$state->{attach_changed}=1;
}
}
print "\n";
next ATTACH_INTERFACE;
}
} elsif (lc($key) eq 'e') { # export
my $to_export = undef;
if (defined($tmp_ent->{binary}) && ref($tmp_ent->{binary}) eq 'HASH') {
if ($strings_count < 1) {
print "\n" .color('yellow'). 'Nothing it attached to export...' .
color('clear')."\n";
} elsif ($strings_count == 1) {
$to_export = $strings_keys[0];
} else {
print "\r". " "x60 ."\rWhich entry number do you want to export? ";
my $choice = get_single_line();
if ($choice !~ m/^\d+$/ || $choice<1 || $choice > $strings_count) {
print "\nInvalid number.";
} else {
$to_export = $strings_keys[$choice-1];
}
}
}
if (defined($to_export) && defined($tmp_ent->{binary}->{$to_export})) {
my $homedir=get_user_homedir();
my @path = File::Spec->splitdir($homedir);
my $iv = File::Spec->catfile(@path, $to_export); # homedir/filename
print "\n";
my $filename = prompt_filename_from_user($self,"Path to file: ",$iv);
if (! length($filename)) { next ATTACH_INTERFACE; }
if (lc($OSNAME) !~ m/^mswin/) { $filename=expand_tildes($filename); }
# If we're given a directory, assume the user wants to write into it
if (-e -d $filename) { $filename .= '/' . $to_export; }
if (-e -f $filename) {
print color('yellow'). "WARNING: file already exists: $filename\n" .
"Overwrite it? [y/N] " .color('clear');
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
next ATTACH_INTERFACE;
}
}
my $fh = new FileHandle;
if (! open($fh,'>', $filename)) {
print "ERROR: cannot write to: $filename\n";
next ATTACH_INTERFACE;
}
print $fh $tmp_ent->{binary}->{$to_export};
close $fh;
print "Saved to: $filename\n";
}
next ATTACH_INTERFACE;
} elsif (lc($key) eq 'a') { # add
if ($strings_count > 0 && $state->{kdb_ver} == 1) {
print "\n" .color('yellow').
'KeePass v1 files support only one attachment per entry.' .
color('clear')."\n";
next ATTACH_INTERFACE;
}
print "\n";
my $filename = prompt_filename_from_user($self, "Path to file: ", "");
if (! length($filename)) { next ATTACH_INTERFACE; }
my $errmsg = do_attach_file($tmp_ent, $filename);
if (defined($errmsg)) {
print color('yellow'). "Error: $errmsg" .color('clear'). "\n";
}
next ATTACH_INTERFACE;
} else {
# Do nothing on invalid input
next COMMAND;
}
}
}
#return $initial_value;
}
# Helper function for cli_attach
sub prompt_filename_from_user {
my $self = shift @_;
my $prompt = shift @_;
my $initial_value = shift @_;
my $term = get_prepped_readline_term();
# Set a completion function for files
my $old_compfunc=undef;
if (my $attr = $term->Attribs) {
# filename_completion_function works for Gnu Readline
if (defined($attr->{filename_completion_function})) {
$old_compfunc = $attr->{completion_entry_function};
$attr->{completion_entry_function} =
$attr->{filename_completion_function};
}
}
# TODO - this need more testing with Perl readlines!!!
if ($self->{term}->ReadLine eq 'Term::ReadLine::Perl') {
#$readline::rl_completion_function = "rl_filename_list";
$old_compfunc = $readline::rl_completion_function;
$readline::rl_completion_function = \&my_nongnu_complete_files;
} elsif ($self->{term}->ReadLine eq 'Term::ReadLine::Perl5') {
$old_compfunc=$Term::ReadLine::Perl5::readline::rl_completion_function;
$Term::ReadLine::Perl5::readline::rl_completion_function =
\&my_nongnu_complete_files;
}
my $filename = $term->readline($prompt, $initial_value);
$filename =~ s/^\s+//; $filename =~ s/\s+$//; # Trim the input
# Restore the old completion function
if (defined($old_compfunc)) {
if (my $attr = $term->Attribs) {
$attr->{completion_entry_function} = $old_compfunc;
}
if ($self->{term}->ReadLine eq 'Term::ReadLine::Perl') {
$readline::rl_completion_function = $old_compfunc;
}
if ($self->{term}->ReadLine eq 'Term::ReadLine::Perl5') {
$Term::ReadLine::Perl5::readline::rl_completion_function =
$old_compfunc;
}
}
return $filename;
}
# Helper function for cli_attach
sub do_attach_file {
my $entry = shift @_;
my $path_to_file = shift @_;
our $state;
if (! -f $path_to_file) {
return "File not found at: $path_to_file";
}
my $size = -s $path_to_file;
if ($size > $MAX_ATTACH_SIZE) {
my $sizeK = sprintf("%0.02f", $size / 1024);
my $maxSizeK = sprintf("%0.02f", $MAX_ATTACH_SIZE / 1024);
return "File is too large ($sizeK versus $maxSizeK KB maximum).";
}
my $fname_short = basename($path_to_file);
if (defined($entry->{binary}->{$fname_short})) {
return "An attachement named \"$fname_short\" already exists.\n";
}
# If we get this far we're OK to attach it
open(my $fh,'<',$path_to_file) || return "Couldn't open file $path_to_file";
read($fh, my $buffer, $size);
close $fh;
if (length($buffer) != $size) {
return "Couldn't read entire key file contents of $path_to_file.\n";
}
$entry->{binary}->{$fname_short} = $buffer;
$state->{attach_changed}=1;
return undef;
}
# Cross-platform attempt to find a user's homedir
sub get_user_homedir {
if (lc($OSNAME) =~ m/^mswin/ &&
defined($ENV{HOMEDRIVE}) && defined($ENV{HOMEPATH})) {
#return $ENV{HOMEDRIVE} . $ENV{HOMEPATH}; # Windows
return File::Spec->catpath($ENV{HOMEDRIVE}, $ENV{HOMEPATH}, undef);
}
my $home = $ENV{HOME} || $ENV{LOGDIR} || (getpwuid($<))[7] || undef; #Unix
return $home;
}
# Expand tildes in filename
sub expand_tildes {
my $filename = shift @_;
# Page 253 of Perl Cookbook By Tom Christiansen, Nathan Torkington
# "O'Reilly Media, Inc.", Aug 21, 2003
$filename =~ s{ ^ ~ ( [^/]* ) }
{ $1
? (getpwnam($1))[7]
: ($ENV{HOME} || $ENV{LOGDIR} || (getpwuid($<))[7])
}ex;
return $filename;
}
# Copied from Term::ShellUI and modified for enhanced Windows support
sub my_nongnu_complete_files {
my ($str, $line, $start) = @_;
#$self->suppress_completion_append_character();
if (defined($readline::rl_completer_terminator_character)) {
$readline::rl_completer_terminator_character='';
}
if (defined($Term::ReadLine::Perl5::readline::rl_completer_terminator_character)) {
$Term::ReadLine::Perl5::readline::rl_completer_terminator_character='';
}
my ($volume,$directories,$file) = File::Spec->splitpath($str || '.', 0 );
# This next line is for Windows tab completion on just "C:","D:", etc.
if (length($volume) && !length($directories)) { $directories='/'; }
my $dir = File::Spec->catpath($volume,$directories,undef);
# eradicate non-matches immediately (this is important if
# completing in a directory with 3000+ files)
$file = '' unless $str;
my $flen = length($file);
my @files = ();
if(opendir(DIR, length($dir) ? $dir : '.')) {
@files = grep { substr($_,0,$flen) eq $file } readdir DIR;
closedir DIR;
# eradicate dotfiles unless user's file begins with a dot
@files = grep { /^[^.]/ } @files unless $file =~ /^\./;
# reformat filenames to be exactly as user typed
@files = map { length($dir) ? ($dir eq '/' ? "/$_" : "$dir/$_") : $_ } @files;
} else {
print("Couldn't read dir: $!\n");
}
# Tack trailing slashs on dirs
foreach my $file_dir (@files) {
if (-d $file_dir && $file_dir !~m/\/$/) { $file_dir .= '/'; }
}
return @files;
}
sub cli_quit($$) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
if ($state->{kdb_has_changed}) {
print "WARNING: The database has changed and was not saved.\n" .
"Really quit? [y/N] ";
my $key=get_single_key();
if (lc($key) ne 'y') {
print "\n";
return -1; # It is not OK to quit
}
}
if (-f $state->{placed_lock_file}) { unlink($state->{placed_lock_file}); }
delete($state->{placed_lock_file});
$self->exit_requested(1);
return 0; # It's OK to quit
}
sub cli_version($$) {
my $self = shift @_;
my $params = shift @_;
our $state;
if (recent_sigint()) { return undef; } # Bail on SIGINT
# Users can provide a -f option to show the password. We use GetOptions
# to parse this command line, and $target holds that target.
my $target='';
my %opts=();
{
local @ARGV = @{$params->{args}};
my $result = &GetOptions(\%opts, 'v');
}
if ($opts{'v'}) {
print "VERSIONS\n";
print " * kpcli: $VERSION\n";
my $pv = $PERL_VERSION;
if (! length($pv)) {
$pv = $]; # For perl versions prior to 5.6.0
}
print " * Perl: $pv\n";
my @modules = qw(File::KeePass Term::ShellUI Term::ReadKey Term::ReadLine);
my @missing_modules = ();
foreach my $module (sort keys %OPTIONAL_PM) {
if ($OPTIONAL_PM{$module}->{loaded}) {
push @modules, $module;
} else {
push @missing_modules, $module;
}
}
foreach my $module (@modules) {
no strict 'refs';
my $vstr=$module . "::VERSION";
print " * $module: " . ${$vstr} . "\n";
}
foreach my $module (@missing_modules) {
print " * $module: not installed (optional)\n";
}
print "\n";
print "ReadLine being used: " . $term->{term}->ReadLine . "\n";
# Operating System
my $OS=$OSNAME;
if (lc($OSNAME) eq 'linux') {
my $lsbr = load_lsb_release();
if (defined($lsbr) && defined($lsbr->{'DISTRIB_DESCRIPTION'})) {
$OS .= " (" . $lsbr->{'DISTRIB_DESCRIPTION'} . ")";
}
} elsif (lc($OSNAME) eq 'mswin') {
if (! $OPTIONAL_PM{'Win32'}->{loaded}) {
runtime_load_module(\%OPTIONAL_PM,'Win32',undef);
}
if ($OPTIONAL_PM{'Win32'}->{loaded}) {
$OS .= " (" . Win32::GetOSDisplayName() . ")";
}
}
print "Operating system: $OS\n";
} else {
print "$VERSION\n";
}
}
sub load_lsb_release {
my $fh = new FileHandle;
if (-f '/etc/lsb-release' && open($fh,'<', '/etc/lsb-release')) {
my @lines = <$fh>;
close $fh;
my %d = ();
foreach my $l (@lines) {
chomp $l;
my ($k,$v) = split(/=/, $l, 2);
$d{$k} = $v;
}
return \%d;
}
return undef;
}
# Function to nag the user about saving each time the DB is modified
sub RequestSaveOnDBChange {
our $state;
# If the db hasn't changed don't bother the user
if (! $state->{kdb_has_changed}) {
return -1;
}
# If this is a newly created file we don't bother the user with
# asking to save after every change.
if (! length($state->{kdb_file})) {
return -1;
}
print "Database was modified. Do you want to save it now? [y/N]: ";
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
return;
}
# Calling cli_save() should be silent and safe at this point.
return cli_save(undef);
}
sub GetMasterPasswd {
my $prompt = "Please provide the master password: ";
return GetPassword($prompt,'*');
}
sub GetMasterPasswdDoubleEntryVerify {
my $master_pass=GetMasterPasswd();
if (recent_sigint()) { return undef; } # Bail on SIGINT
if (length($master_pass) == 0) { return ''; }
my $prompt = "Retype to verify: ";
my $checkval = GetPassword($prompt,'*');
chomp $checkval;
if (recent_sigint()) { return undef; } # Bail on SIGINT
if ($master_pass ne $checkval) {
print "Passwords did not match...\n";
return undef;
}
return $master_pass;
}
sub GetPassword {
my $prompt = shift @_;
my $echo_char = shift @_ || '';
if (length($echo_char) > 1) {
warn "GetPassword() cannot accept an \$echo_char of more than one char.\n";
$echo_char='';
}
$|=1; # Needed to flush STDOUT on Windows cmd prior to calling ReadMode
ReadMode('noecho');
ReadMode('raw');
my $master_pass = '';
print $prompt;
CHAR: while (1) {
my $c;
do {
Time::HiRes::sleep(0.05);
} until defined($c = ReadKey(-1));
last if $c =~ m/[\n\r]/;
if (ord($c) == 3) { # ^C
print "\n";
ReadMode('normal');
kill SIGINT, $$; # Due to raw mode, I must send the SIGINT to myself.
return '';
} elsif (ord($c) == 127 || ord($c) == 8) { # backspace (Linux/Windows)
if (length($master_pass)) {
print chr(8)." ".chr(8);
chop($master_pass);
}
next CHAR;
} elsif (ord($c) == 21) { # ^U
my $passlen=length($master_pass);
print chr(8)x$passlen." "x$passlen.chr(8)x$passlen;
$master_pass = '';
next CHAR;
}
if (length($echo_char)) { print $echo_char; }
#print "*".ord($c);
$master_pass .= $c;
}
ReadMode('normal');
chomp $master_pass;
my $min_display_length = 25;
if (length($master_pass) < $min_display_length) {
print "$echo_char"x($min_display_length - length($master_pass));
}
print "\n"; $|=1;
if (recent_sigint()) { return undef; } # Bail on SIGINT
return $master_pass;
}
sub MyGetOpts {
my %opts=();
my $result = &GetOptions(\%opts, "kdb=s", "key=s", "pwfile=s", "histfile=s",
"help", "h", "readonly", "no-recycle", "timeout=i", "command=s");
# If the user asked for help or GetOptions complained, give help and exit
if ($opts{help} || $opts{h} || (! int($result))) {
print GetUsageMessage();
exit;
}
# Allow the user to override the history file
if (defined($opts{histfile}) && length($opts{histfile})) {
our $HISTORY_FILE = $opts{histfile};
} else {
if (lc($OSNAME) =~ m/^mswin/) {
our $HISTORY_FILE = $ENV{USERPROFILE} . "/.$APP_NAME-history";
} else {
our $HISTORY_FILE = "~/.$APP_NAME-history";
}
}
my @errs=();
if ((length($opts{kdb}) && (! -e $opts{kdb}))) {
push @errs, "for option --kdb=<file.kbd>, the file must exist.";
}
if ((length($opts{key}) && (! -e $opts{key}))) {
push @errs, "for option --key=<file.key>, the file must exist.";
}
if (scalar(@errs)) {
warn "There were errors:\n" .
" " . join("\n ", @errs) . "\n\n";
die &GetUsageMessage();
}
return \%opts;
}
sub GetUsageMessage {
my @params = (
[ kdb => 'Optional KeePass database file to open (must exist).' ],
[ key => 'Optional KeePass key file (must exist).' ],
[ pwfiles => 'Read master password from file instead of console.' ],
[ histfile => 'Specify your history file (or perhaps /dev/null).' ],
[ readonly => 'Run in read-only mode; no changes will be allowed.' ],
[ "timeout=i" => 'Lock interface after i seconds of inactivity.' ],
[ command => 'Run single command and exit (no interactive session).' ],
[ 'no-recycle' =>
'Don\'t store entry changes in /Backup or "/Recycle Bin".' ],
[ help => 'This message.' ],
);
my $t="Usage: $APP_NAME [--kdb=<file.kdb>] [--key=<file.key>]\n" .
"\n";
foreach my $param (@params) {
$t .= sprintf(" %-13s %s\n", '--'.$param->[0], $param->[1]);
}
$t .= "\n" .
"Run kpcli with no options and type 'help' at its command prompt to learn\n" .
"about kpcli's commands.\n" .
"";
return $t;
}
# Because Term::ShellUI has a fixed width (%20s) for the command length
# and we don't need nearly that much, we had to implement our own help
# function instead of using the built-in help_call() method.
sub my_help_call($) {
my $term = shift @_;
# @_ now holds: [Term::ShellUI->{commands}, <optional: specific command>]
# If the user is asking for detailed help on a specific command, do that
if (scalar(@_) > 1) {
$term->help_call(undef, @_);
return;
}
# If no specific command was requested, show the command summaries
my $help = $term->get_all_cmd_summaries($term->commands());
$help =~ s/^ {12}//gm; # Trim some leading spaces off of each line of output
print $help;
print "\n" .
"Type \"help <command>\" for more detailed help on a command.\n";
return 0;
}
########################################################################
# Command Completion Routines ##########################################
########################################################################
sub complete_groups {
my $self = shift;
my $cmpl = shift;
our $state;
# Place the string (token) that the user is trying to complete into $path.
my $path = $cmpl->{tokens}->[$cmpl->{tokno}];
# If the cursor isn't at the end of the sting, chop $path to that length.
if (length($path) > $cmpl->{tokoff}) {
$path = substr($path, 0, $cmpl->{tokoff});
}
my $srch_path=normalize_path_string($path);
my @possibles = ();
# If the path ends in a "/" (a directory) then we are looking for subirs,
# else we are just looking to tab-complete a partial dir-name at this level.
# Used only for /<tab> (the root dir is a special case)
if ($srch_path =~ m/^$|^[.]$/) {
@possibles = grep(/^[^\0]+$/,
sort keys %{$state->{all_grp_paths_fwd}});
# Used only for /..any/thing../<tab> (non-root directories)
} elsif (defined($state->{all_grp_paths_fwd}->{$srch_path})) {
# If the user is sitting on a dir without the trailing /, return that
# now as the only option (/dir1/dir2<tab>). We do this because the
# code later does not handle this case well at all. We do, however,
# have to not do this for things like "ls <tab>" which is why we test
# for length($path).
if (length($path) && $path !~ m/\/$/) {
__my_suppress_completion_append_character($self);
return [ $cmpl->{str} . "/" ];
}
@possibles = grep(/^\Q$srch_path\E\0[^\0]+$/,
sort keys %{$state->{all_grp_paths_fwd}});
# Used for /../any/thing../foo<tab>
} else {
@possibles = grep(/^\Q$srch_path\E[^\0]*$/,
sort keys %{$state->{all_grp_paths_fwd}});
}
# Loop over the possibilites doing required magic...
my @results=();
foreach my $opt (@possibles) {
$opt=humanize_path($opt);
if ($path =~ m/^(\/+)/) { # Absolute path (easy case!)
$opt=$1.$opt;
} else { # Path relative to pwd
my $user_new_path=get_pwd() . "/" . $path;
my $new_dir=normalize_path_string($user_new_path);
# If the user's input does not resolve to a fully qualified
# path then we need to pop off the last bit to get to that.
if (! defined($state->{all_grp_paths_fwd}->{$new_dir})) {
my @path=split(/\0/, $new_dir); pop @path;
$new_dir = join("\0", @path);
}
$new_dir = humanize_path($new_dir);
# Dirname requires "../." (Trailing dot) to give ".." in those cases!
my $dirname_path=$path;
if ($path =~ m/\/$/) { $dirname_path .= "."; }
my $path_to_put_back=dirname($dirname_path) . "/";
if ($new_dir eq '') { # All the way at the root level
$opt = $path_to_put_back . $opt;
} else { # Some non-root level (deeper)
$opt=~s/^$new_dir\//$path_to_put_back/;
}
# Lop the leading "./" off the head if it was not user supplied
if ($path !~ m/^[.]\// && $opt =~ m/^[.]\//) { $opt =~ s/^[.]\///; }
# If the user did supply a leading "./" and we missed it, add it
if ($path =~ m/^[.]\// && $opt !~ m/^[.]\//) { $opt = "./$opt"; }
}
push @results, "$opt/";
}
# Foreach possibility, we have to strip off the parts that are already
# completed and then prepend the part that is looking to be completed,
# from $cmpl->{str}.
my @completions = ();
foreach my $possibility (@results) {
$possibility = normalize_path_string($possibility);
$possibility =~ s/^\Q$srch_path\E\0?//;
if (length($possibility)) {
$possibility = $cmpl->{str} . humanize_path($possibility);
if ($possibility !~ m/\/$/) { $possibility .= '/'; }
push @completions, $possibility;
}
}
# If we are about to return only one completion result, we need to first
# test to see if any other subdirs are below it and, if so, suppress the
# completion append character so that the user can keep tab completing
# into lower level directories.
if (scalar(@completions) == 1) {
my @all_subdirs = grep(/^\Q$srch_path\E[^\0]*(\0[^\0]+)?/,
sort keys %{$state->{all_grp_paths_fwd}});
if (scalar(@all_subdirs) > 0) {
__my_suppress_completion_append_character($self);
}
}
return \@completions;
}
sub complete_entries {
my $self = shift;
my $cmpl = shift;
our $state;
# Place the string (token) that the user is trying to complete into $path.
my $path = $cmpl->{tokens}->[$cmpl->{tokno}];
# If the cursor isn't at the end of the sting, chop $path to that length.
if (length($path) > $cmpl->{tokoff}) {
$path = substr($path, 0, $cmpl->{tokoff});
}
my $srch_path=normalize_path_string($path);
my @entries = grep(/^\Q$srch_path\E\0?[^\0]*$/,
sort keys %{$state->{all_ent_paths_fwd}});
# User can tab exactly at a directory level and with or without the
# trailing slash, and so we need to normalize that, always ensuring that
# the slash is inserted. We do that by setting the dir_level_sep here
# and always removing any trailing slash sent in below (\0 on srch_path).
# We do, however, have to not do this for things like "show <tab>" which
# is why we test for length($path).
my $dir_level_sep = '';
if (defined($state->{all_grp_paths_fwd}->{$srch_path}) &&
length($path) && $path !~ m/\/$/) {
$dir_level_sep = '/';
}
# Foreach possibility, we have to strip off the parts that are already
# completed and then prepend the part that is looking to be completed
# by Term::ShellUI, from $cmpl->{str}.
my @completions = ();
foreach my $possibility (@entries) {
$possibility =~ s/^\Q$srch_path\E\0?//;
if (length($possibility)) {
$possibility = $cmpl->{str} .$dir_level_sep. humanize_path($possibility);
push @completions, $possibility;
}
}
return \@completions;
}
sub complete_groups_and_entries {
my $self = shift;
my $cmpl = shift;
my $groups = complete_groups($self,$cmpl);
my $entries = complete_entries($self,$cmpl);
# Merge and sort the groups and entries
my @completions = sort (@{$groups}, @{$entries});
return \@completions;
}
# In Term::ReadLine::Gnu, suppress_completion_append_character() works,
# but in Term::ReadLine::Perl and Term::ReadLine::Perl5 it does not, and
# so we get to the outcome via $readline::rl_completer_terminator_character.
sub __my_suppress_completion_append_character($) {
my $self = shift;
if ($self->{term}->ReadLine eq 'Term::ReadLine::Gnu') {
$self->suppress_completion_append_character();
} else {
# For Term::ReadLine::Perl
# From Term/ReadLine/readline.pm
# - package readline;
if (defined($readline::rl_completer_terminator_character)) {
$readline::rl_completer_terminator_character='';
}
# For Term::ReadLine::Perl5
# From Term/ReadLine/Perl5/readline.pm
# - package Term::ReadLine::Perl5::readline;"
if (defined(
$Term::ReadLine::Perl5::readline::rl_completer_terminator_character)) {
$Term::ReadLine::Perl5::readline::rl_completer_terminator_character='';
}
}
}
########################################################################
# Rijndael encrypt/decrypt routines - borrowed from File::KeePass ######
########################################################################
sub decrypt_rijndael_cbc {
my ($buffer, $key, $enc_iv) = @_;
my $cipher = Crypt::Rijndael->new($key, Crypt::Rijndael::MODE_CBC());
$cipher->set_iv($enc_iv);
$buffer = $cipher->decrypt($buffer);
my $extra = ord(substr $buffer, -1, 1);
substr($buffer, length($buffer) - $extra, $extra, '');
return $buffer;
}
sub encrypt_rijndael_cbc {
my ($buffer, $key, $enc_iv) = @_;
my $cipher = Crypt::Rijndael->new($key, Crypt::Rijndael::MODE_CBC());
$cipher->set_iv($enc_iv);
my $extra = (16 - length($buffer) % 16) || 16; # pad so we can trim
$buffer .= chr($extra) for 1 .. $extra;
return $cipher->encrypt($buffer);
}
sub composite_master_pass($$) {
my ($pass, $key_file) = @_;
# composite password in case of key file
if (defined $key_file and length($key_file) and -f $key_file) {
# KeePass v2.03 and higher has native key file support, and so we
# use that if we have it.
if (version->parse($File::KeePass::VERSION) >= version->parse('2.03')) {
return [$pass, $key_file];
}
# TODO - at some point, when File::KeePass v2.03 is very mainstream,
# the code to the end of this if block should be removed. It allowed
# support for key files for *.kdb files before File::KeePass supported
# that natively. File::KeePass now also supports that for *.kdbx.
open(my $fh,'<',$key_file) || die "Couldn't open key file $key_file: $!\n";
my $size = -s $key_file;
read($fh, my $buffer, $size);
close $fh;
if (length($buffer) != $size) {
die "Couldn't read entire key file contents of $key_file.\n";
}
$pass = substr(sha256($pass),0,32);
if ($size == 32) {
$pass .= $buffer;
} elsif ($size == 64) {
for (my $i = 0; $i < 64; $i += 2) {
$pass .= chr(hex(substr($buffer,$i,2)));
}
} else {
$pass .= substr(sha256($buffer),0,32);
}
# TODO - this marks the "end of the block" noted above.
}
return $pass;
}
sub put_master_passwd($) {
my $master_pass = shift @_;
our $state;
$state->{'master_pass_key'}='';
$state->{'master_pass_key'} .= chr(int(255 * rand())) for 1..16;
$state->{'master_pass_enc_iv'}='';
$state->{'master_pass_enc_iv'} .= chr(int(255 * rand())) for 1..16;
$master_pass='CLEAR:' . $master_pass;
$state->{'master_pass'}=encrypt_rijndael_cbc($master_pass,
$state->{'master_pass_key'}, $state->{'master_pass_enc_iv'});
return 0;
}
sub get_master_passwd() {
our $state;
my $master_pass=decrypt_rijndael_cbc($state->{master_pass},
$state->{'master_pass_key'}, $state->{'master_pass_enc_iv'});
if ($master_pass=~s/^CLEAR://) {
return $master_pass;
} else {
die "Failed to properly decrypt my copy of the master password.\n";
}
}
# This routine checks to see if the file has changed on disk and warns if so
sub warn_if_file_changed {
our $state;
my $file = $state->{kdb_file};
if (! length($file)) { return 0; } # If no file was opened, don't warn
my $file_md5 = Digest::file::digest_file_hex($file, "MD5");
if ($state->{kdb_file_md5} ne $file_md5) {
print color('bold yellow') . "WARNING:" . color('clear') .
color('red') .
" The file has changed on disk since kpcli opened it!\n" .
" It may be opened elsewhere. Continue anyway? [y/N] " .
color('clear');
my $key=get_single_key();
print "\n";
if (lc($key) ne 'y') {
return -1;
}
}
return 0;
}
sub generateKeyfileContents($) {
my $length = shift;
my $password = '';
my @normal_chars=('a'..'z','A'..'Z',0..9);
# all printable non-alnum chars except space (0x20), backspace (0x5c),
# and backtick (0x60)
my @special_chars=map(chr, 0x21 .. 0x2f, 0x3a .. 0x40,
0x5b, 0x5d .. 0x5f, 0x7b .. 0x7e);
my $charset = join('', (@normal_chars,@special_chars));
while (length($password) < $length) {
$password .= substr($charset, (int(rand(length($charset)))), 1);
}
return $password;
}
sub generatePassword {
my $be_silent = shift @_ || 0;
my $password = generatePasswordFromDict($be_silent);
if (! length($password)) {
if (! $be_silent) {
print color('yellow') .
"Generated random characters instead of a words-based password.\n" .
color('clear');
}
$password = generatePasswordGobbledygook(20);
}
return $password;
}
sub generatePasswordGobbledygook {
my $length = shift;
my @normal_chars=('a'..'z','A'..'Z',0..9);
my @special_chars=qw(_);
my $charset = join('', (@normal_chars,@special_chars));
# Generate the password
my $password = '';
while (length($password) < $length) {
$password .= substr($charset, (int(rand(length($charset)))), 1);
}
# Make sure that at least one special character appears
my $sccc=join('', @special_chars);
if ($password !~ m/[\Q$sccc\E]/) {
my $sc=$special_chars[int(rand(length($sccc)))];
substr($password,int(rand(length($password))), 1, $sc);
}
return $password
}
sub genPassInteractiveHelper($$) {
my $mode = shift @_;
my $len = shift @_;
if ($mode eq 'g') {
return generatePasswordGobbledygook($len);
} elsif ($mode eq 'w') {
return generatePasswordFromDict(0);
} else {
return undef;
}
}
sub generatePasswordInteractive($) {
my $default_passwd_len = shift @_;
print "\n";
print "INTERACTIVE PASSWORD GENERATION:\n";
print "<n>o/<ret> Do not accept current password, generate another one.\n";
print "<y>es Accept current password.\n\n";
print "<t>oggle Toggle between random characters and word-based mode.\n";
print "<c>ancel Abort interactive password generation mode.\n";
print "And in random characters mode:\n";
print " +/- Increase/decrease password length. " .
"May be prefixed with a count.\n";
print " [n]= Set password length to [n] chars. If not given, " .
"resets to $DEFAULT_PASSWD_LEN chars.\n";
my $pw_is_ok = 0;
my $len = $default_passwd_len;
my $mode = 'g';
my $pw = genPassInteractiveHelper($mode,$len);
do {
my $prompt_format = "%s +/-/= n/y/t/c ";
if ($mode eq 'w') { $prompt_format = "%s n/y/t/c "; }
my $prompt = sprintf($prompt_format, $pw);
print $prompt;
my $input = '';
my $input_complete = 0;
do {
if (recent_sigint()) { return undef; }
my $k = get_single_key();
if (recent_sigint()) { return undef; }
my $kc = unpack("C", $k);
if ($kc == 0x03) { # ^C
return undef;
} elsif ($kc == 127 || $kc == 8) { # backspace (Linux/Windows)
if (length($input) > 0) {
$input = substr($input,0,length($input) - 1);
print chr(8)." ".chr(8); # Erase a character
#print $k; # Print the backspace key to erase a character
}
} elsif ($kc == 0x0a) {
$input = '';
$input_complete = 1;
} else {
# Validate character input then process it
if ($input eq '' && $k =~ m/^[tcny]$/
|| ($mode eq 'g' && $k =~ m/^[\d\+\-=]$/ && $input =~ m/^\d*$/)
) {
$input .= $k;
if ($mode eq 'g' && $input =~ /^(\d+)?[+=-]$/) {$input_complete=1;}
if ($input =~ /^[tcny]$/ ) { $input_complete = 1; }
if ($input =~ /^\d/) { print $k; }
}
}
} while (!$input_complete);
print "\n";
if (lc($input) eq 't') {
if ($mode eq 'g') { $mode = 'w' } else { $mode = 'g'; }
$input = 'n';
}
if ($input eq 'y') {
length($pw) and $pw_is_ok = 1;
} elsif ($mode eq 'g' && $input =~ /^(\d+)?[+=-]$/) {
my $new_len = $DEFAULT_PASSWD_LEN;
if ($input =~ /^(\d+)?=$/) {
$new_len = $1 || $DEFAULT_PASSWD_LEN;
} elsif ($input =~ /^(\d+)?([+-])$/) {
my $v = $1 ? $1 : 1;
$v *= $2 eq '-' ? -1 : 1;
$new_len = $len + $v;
}
if ($new_len < $DEFAULT_PASSWD_MIN) {
$len = $DEFAULT_PASSWD_MIN;
} elsif ($new_len > $DEFAULT_PASSWD_MAX) {
$len = $DEFAULT_PASSWD_MAX;
} else {
$len = $new_len;
printf "[%s%s%s]\n",
'-' x ($len - $DEFAULT_PASSWD_MIN), '|',
'-' x ($DEFAULT_PASSWD_MAX - $len);
}
if (recent_sigint()) { return undef; }
$pw = genPassInteractiveHelper($mode,$len);
} elsif ($input eq 'c') {
return undef; # Return undef on cancel
} elsif ($input eq 'n' || !$input) {
if (recent_sigint()) { return undef; }
$pw = genPassInteractiveHelper($mode,$len);
}
} while (!$pw_is_ok);
return($pw);
}
# Inspired by http://xkcd.com/936/
sub generatePasswordFromDict($) {
my $be_silent = shift @_ || 0;
my @words=();
my $fh = new FileHandle;
my @dict_files = qw(/usr/share/dict/words /usr/dict/words);
DICTS: foreach my $dictfile (@dict_files) {
if (-f $dictfile && -r $dictfile && open($fh,'<', $dictfile)) {
@words = <$fh>;
close($fh);
last DICTS;
}
}
if (scalar(@words) < 10000) {
if (! $be_silent) {
print color('yellow') .
"No adequate dictionary found to generate a words-based password.\n".
"These locations were checked:\n - ".join("\n - ", @dict_files)."\n" .
color('clear');
}
return undef;
}
my $length_tries = 12;
my $password='';
do {
my @passwords = ();
my $word_tries=20;
while (scalar(@passwords) < 4 && $word_tries-- > 0) {
my $word = $words[int(rand(scalar(@words)))];
chomp $word;
$word =~ s/[^a-zA-Z0-9]//g;
if (length($word) > 7) { next; } # Don't care for big words
push @passwords, $word;
}
if (scalar(@passwords) == 4) {
$password=join('.', @passwords);
}
#warn "LHHD: $password\n";
if (length($password) < 27) { $password=''; } # Need a decent overall size
} until (length($password) || $length_tries-- < 0);
return $password;
}
# Adapted from http://docstore.mik.ua/orelly/perl/cookbook/ch06_10.htm
sub glob2pat {
my $globstr = shift;
my %patmap = (
'*' => '[^\0]*',
'?' => '[^\0]',
'[' => '[',
']' => ']',
);
$globstr =~ s{(.)} { $patmap{$1} || "\Q$1" }ge;
return '^' . $globstr . '$';
}
sub shell_expansion($) {
my $shell_path = shift @_;
our $state;
my $regex = glob2pat(normalize_path_string($shell_path));
$regex = qr/$regex/;
my @grps_and_ents = ();
push @grps_and_ents, keys %{$state->{all_ent_paths_fwd}};
push @grps_and_ents, keys %{$state->{all_grp_paths_fwd}};
@grps_and_ents = sort { ncmp($a,$b); } @grps_and_ents;
my @matches = grep(/${regex}/, @grps_and_ents);
# Eliminate "system" things that we don't want to include
my @good_matches = ();
MATCHES: foreach my $match (@matches) {
if (defined($state->{all_ent_paths_fwd}->{$match})) {
my $ent = $state->{kdb}->find_entry({id=>$state->{all_ent_paths_fwd}->{$match}});
if (defined($ent) && $ent->{'title'} eq 'Meta-Info' && $ent->{'username'} eq 'SYSTEM') {
next MATCHES;
}
}
push @good_matches, $match;
}
return @good_matches;
}
#########################################################################
# Setup signal handling #################################################
#########################################################################
sub setup_signal_handling {
our $state;
# We only worry with signal handling for Term::ReadLine::Gnu
if ($state->{'term'}->{term}->ReadLine ne 'Term::ReadLine::Gnu') {
return 0;
}
# We don't want Term::Readline::Gnu catching signals, except for WINCH.
# I really don't understand why, but I know via experimentation.
my $term = $state->{'term'}->{term};
$term->Attribs->{catch_signals} = 0;
$term->Attribs->{catch_sigwinch} = 1; # Window resizes
$term->clear_signals();
# Install a signal handler to catch SIGINT (^C). Unsafe signal handling
# (through POSIX::SigAction) is required to deal with Term::ReadLine::Gnu.
# We don't even try for other readlines due to their limited functionality.
my $handler_SIGINT = sub {
our $state;
# We could be using one of a couple of ReadLine terminals; the one
# from Term::ShellUI ($state->{'term'}->{term}) or one from one of
# our cli_NNN commands ($state->{active_readline}). We will assume
# the Term::ShellUI one here, and override that below if needed.
my $term = $state->{'term'}->{term};
# Record in our state when a SIGINT was last received
$state->{signals}->{INT} = [gettimeofday];
# We need to pull the Carp longmess to see if we're sitting in a
# a cli_XXXX function instead of at a readline prompt.
my $mess = longmess();
#print Dumper( $mess );
# At some point, Term::ShellUI started wrapping my cli_XXX() routines
# in eval{}, which hid the cli_\w+() from the longmess, and so I had
# to add a second condition here.
if ($mess =~ m/(main::(cli_\w+)\(|Term::ShellUI::call_cmd\()/) {
#warn "It appears that SIGINT was called from $1\n";
#warn "LHHD: $mess\n";
# If the cli_NNN has an active_readline we need to work with it
if (defined($state->{active_readline})) {
#warn "LHHD: in INT with active_readline\n";
my $term = $state->{active_readline};
$term->free_line_state();
$term->cleanup_after_signal();
$term->reset_after_signal();
$term->Attribs->{line_buffer}=''; # Clear the buffer
$term->Attribs->{done}=1; # Ask readline to return immediately
}
} else { # If not in a cli_XXX(), assume a Term::ShellUI prompt
my $yellow=color('yellow');
my $clear=color('clear');
#$term->echo_signal_char(SIGINT); # Puts ^C on the next line. :(
# Trial and error on these readline_state values... :(
#warn "LHHD: " . sprintf($term->Attribs->{readline_state}) . "\n";
if ($term->Attribs->{readline_state} == 262374) {
print "^C$yellow - use Ctrl-g to stop history search.$clear\n";
} else {
print "^C$yellow - use the \"quit\" command to exit.$clear\n";
}
$term->free_line_state();
$term->cleanup_after_signal();
$term->reset_after_signal();
$term->Attribs->{line_buffer}=""; # Clear the input buffer
$term->forced_update_display(); # Force update the display
}
return 0;
};
sigaction(SIGINT, new POSIX::SigAction($handler_SIGINT));
#$SIG{INT} = $handler_SIGINT; # Works only if $ENV{PERL_SIGNAL}='unsafe'
#https://groups.google.com/forum/#!topic/perl.perl5.porters/fNJdyyZh7Wc
# Handle signal CONT - continue signal (resuming after Ctrl-Z).
my $handler_SIGCONT = sub {
our $state;
my $term = $state->{'term'}->{term};
my $mess = longmess();
# At some point, Term::ShellUI started wrapping my cli_XXX()
# routines in eval{}, which hid the cli_\w+() from the longmess,
# and so I had to add a second condition here.
if ($mess =~ m/(main::(cli_\w+)\(|Term::ShellUI::call_cmd\()/ &&
defined($state->{active_readline})) {
$term = $state->{active_readline};
}
$term->cleanup_after_signal();
$term->reset_after_signal();
$term->forced_update_display(); # Force update the display
};
sigaction(SIGCONT, new POSIX::SigAction($handler_SIGCONT));
#$SIG{CONT} = $handler_SIGCONT; # Works only if $ENV{PERL_SIGNAL}='unsafe'
}
#########################################################################
# Setup timeout handling (--timeout=N) ##################################
#########################################################################
sub setup_timeout_handling {
our $state;
$state->{last_activity_time}=time;
our $def_call_command = \&Term::ShellUI::call_command;
if ($state->{OPTIONAL_PM}->{'Sub::Install'}->{loaded}) {
Sub::Install::reinstall_sub({
into => "Term::ShellUI",
as => 'call_command',
code =>
sub {
our $state;
my $self = $_[0];
my $parms = $_[1];
my $cmd = $self->get_cname($parms->{cname});
my $idletime = abs($state->{last_activity_time} - time);
my $timeout_exempt=0;
my $all_commands = $self->commands();
if (defined($all_commands->{$cmd}) &&
defined($all_commands->{$cmd}->{timeout_exempt}) &&
$all_commands->{$cmd}->{timeout_exempt}) {
$timeout_exempt=1;
}
if (defined($state->{kdb_file}) && length($state->{kdb_file}) &&
($timeout_exempt == 0) && ($idletime > $opts->{timeout})) {
print "You were idle for more than $opts->{timeout} seconds...\n";
# GetMasterPasswd()=from user; get_master_passwd()=for kdb file
if (GetMasterPasswd() ne get_master_passwd()) {
print "Wrong password.\n";
return -1;
}
$idletime = 0; # Reset idle time on successful password.
}
# Update the state->{last_activity_time} only if not already past
# the timeout; the command could have been one one of the the
# timeout_exempt ones, as defined in main Term::SehllUI data.
if ($idletime <= $opts->{timeout}) {
$state->{last_activity_time}=time;
}
# Call Term::ShellUI::call_command()
our $def_call_command;
return &$def_call_command(@_);
},
});
}
}
# Code consolidation function to runtime-load optional perl modules
sub runtime_load_module {
my $rOPTIONAL_PM = shift @_;
my $module = shift @_;
my $rImportList = shift @_ || undef;
my $iltxt = '';
if (defined($rImportList) && ref($rImportList) ne 'ARRAY') {
die "The rImportList param to runtime_load_module() must be an ARRAY ref\n";
}
if (defined($rImportList) && ref($rImportList) eq 'ARRAY' &&
scalar(@$rImportList) > 0) {
$iltxt = "('" . join("','", @{$rImportList}) . "')";
}
if (eval "require $module;$module->import($iltxt);1;" eq 1) {
$rOPTIONAL_PM->{$module}->{loaded} = 1;
return 1;
} else {
$rOPTIONAL_PM->{$module}->{loaded} = 0;
return 0;
}
}
# This routine runs down the list of our preferred Term::ReadLine::*
# modules and returns a new object from the first one that we find.
sub get_readline_term {
my $rOPTIONAL_PM = shift @_;
my $app_name = shift @_;
my @rl_modules = ();
if (defined($FORCED_READLINE) && length($FORCED_READLINE)) {
push @rl_modules, $FORCED_READLINE;
} else {
# The full list of readlines that we support, in order of preference
push @rl_modules, 'Term::ReadLine::Gnu';
push @rl_modules, 'Term::ReadLine::Perl';
push @rl_modules, 'Term::ReadLine::Perl5';
}
my $rl_term = undef;
my $hold_TERM=undef;
MODULE: foreach my $module (@rl_modules) {
# On MS Windows, Term::ReadLine::Perl and Term::ReadLine::Perl5 are
# pretty good terminals but they behave badly if the environment
# variable TERM=dumb, and so we override that here if needed.
if (lc($OSNAME) =~ m/^mswin/ && $module =~ m/^Term::ReadLine::Perl5?/ &&
$ENV{'TERM'} eq 'dumb') {
$hold_TERM=$ENV{'TERM'};
$ENV{'TERM'} = 'vt102';
}
if (runtime_load_module($rOPTIONAL_PM,$module,undef) eq 1) {
# These SGI{'__WARN__'} shenanigans are to suppress:
# WARNING: Use of inherited AUTOLOAD for non-method
# Term::ReadLine::Gnu::ornaments() is deprecated at
# /usr/lib/perl5/Term/ReadLine/Gnu.pm line 250.
# Hopefully, newer versions of Term::ReadLine::Gnu will fix this.
$SIG{'__WARN__'} =
sub { warn $_[0] unless (caller eq "Term::ReadLine::Gnu"); };
$rl_term = eval "$module->new('$app_name');";
delete $SIG{'__WARN__'};
last MODULE;
} else {
#warn "Loading $module failed\n";
if (defined($hold_TERM)) { $ENV{'TERM'} = $hold_TERM; $hold_TERM=undef; }
}
}
#if (! defined($rl_term)) { return undef; }
if (! defined($rl_term)) {
die "No usable Term::ReadLine::* modules found.\n" .
"This list was tried:\n * " . join("\n * ", @rl_modules) . "\n" .
"For more information, read the documentation: " .
"perldoc " . basename($0) . "\n";
}
# I don't like readline ornaments in kpcli
if (lc($OSNAME) =~ m/^mswin/ && $rOPTIONAL_PM->{'Capture::Tiny'}->{loaded}) {
# On MS Windows, the RLTERM->ornaments() call causes a warning about
# not having a termcap file. It seems hamless and so we suppress that
# message if we have Capture::Tiny available.
my ($out, $err, @result) = capture( sub { $rl_term->ornaments(0); } );
if (length($err) && $err !~ m/^cannot find termcap/i) { warn $err; }
} else {
# WARNING: Use of inherited AUTOLOAD for non-method
# Term::ReadLine::Gnu::ornaments() is deprecated
# at line <two lines below>.
# This "no warnings" is to stop that, but the same warning
# still comes from Term::ReadLine::Gnu at line 250 with perl
# v5.14.2 and Term::ReadLine::Gnu 1.20-2. That is suppressed
# in a different way, just above in this same function.
no warnings qw(deprecated);
$rl_term->ornaments(0);
use warnings qw(all);
}
# I'm not sure that these are only needed on Windows, but I know they
# are not needed on Linux so I'm trying to keep the scope narrow.
if (lc($OSNAME) =~ m/^mswin/ &&
$rl_term->ReadLine =~ m/Term::ReadLine::Perl5?/) {
# For Term::ReadLine::Perl and Term::ReadLine::Perl we set
# $readline::rl_scroll_nextline=0 on MS Windows.
if (defined($readline::rl_scroll_nextline)) {
$readline::rl_scroll_nextline=0;
}
if (defined($Term::ReadLine::Perl5::readline::rl_scroll_nextline)) {
$Term::ReadLine::Perl5::readline::rl_scroll_nextline=0;
}
}
# History
# The Term::ReadLine::Perl* modules shove values into the history
# file automtically. That causes two problems for kpcli:
# 1) Term::ShellUI calls $term->addhistory() itself for each CLI
# command that it wants to store ih history (duplicates).
# 2) We use readline() in places like cli_new, cli_edit, etc. and
# we do not want all those inputs in the history file (cruft).
if ($rl_term->ReadLine eq 'Term::ReadLine::Perl') {
no strict 'refs';
*readline::add_line_to_history = sub { return undef; };
}
if ($rl_term->ReadLine eq 'Term::ReadLine::Perl5') {
no strict 'refs';
*Term::ReadLine::Perl5::readline::add_line_to_history = sub {return undef;}
}
if (defined($hold_TERM)) { $ENV{'TERM'} = $hold_TERM; }
return $rl_term;
}
# Use simple magic recipes to identify relevant file types
sub magic_file_type($) {
my $filename = shift @_;
my $header='';
my $fh = FileHandle->new($filename, "r");
if (defined $fh) {
my $n = read $fh, $header, 4;
close $fh;
}
# KeePass
# Recipe from https://github.com/glensc/file/blob/master/magic/Magdir/keepass
#0 lelong 0x9AA2D903 Keepass password database
#>4 lelong 0xB54BFB65 1.x KDB
#>>48 lelong >0 \b, %d groups
#>>52 lelong >0 \b, %d entries
#>>8 lelong&0x0f 1 \b, SHA-256
#>>8 lelong&0x0f 2 \b, AES
#>>8 lelong&0x0f 4 \b, RC4
#>>8 lelong&0x0f 8 \b, Twofish
#>>120 lelong >0 \b, %d key transformation rounds
#>4 lelong 0xB54BFB67 2.x KDBX
if ($header =~ m/^(\x9a\xa2\xd9\x03|\x03\xd9\xa2\x9a)/) { # See SF bug #19
return 'keepass';
}
# Password Safe v3
# Recipe from https://github.com/glensc/file/blob/master/magic/Magdir/pwsafe
if ($header =~ m/^PWS3/) {
return 'pws3';
}
return undef;
}
# Unix-style, "touch" a file
sub touch_file {
my $filename = shift @_;
if (! -f $filename) {
my $fh=new FileHandle;
open($fh, "> $filename");
close($fh);
}
my $sig_pipe_store=$SIG{'PIPE'};
$SIG{'PIPE'} = 'IGNORE';
my $now=time;
my $retval=utime $now, $now, $filename;
$SIG{'PIPE'} = $sig_pipe_store;
return($retval);
}
# Convenience function to uniq an array
sub uniq {
my %seen;
return grep { !$seen{$_}++ } @_;
}
########################################################################
# POD ##################################################################
########################################################################
=head1 NAME
kpcli - A command line interface to KeePass database files.
=head1 DESCRIPTION
A command line interface (interactive shell) to work with KeePass
database files (http://en.wikipedia.org/wiki/KeePass). This
program was inspired by my use of "kedpm -c" combined with my need
to migrate to KeePass. The curious can read about the Ked Password
Manager at http://kedpm.sourceforge.net/.
=head1 USAGE
Please run the program and type "help" to learn how to use it.
Run the program with --help as a command line option to learn about
its command line options.
=head1 PREREQUISITES
This program requires these non-core modules:
C<Crypt::Rijndael> - libcrypt-rijndael-perl on Ubuntu 10.04
C<Term::ReadKey> - libterm-readkey-perl on Ubuntu 10.04
C<Sort::Naturally> - libsort-naturally-perl on Ubuntu 10.04
C<File::KeePass> - libfile-keepass-perl on Ubuntu 12.04
C<Term::ShellUI> - libterm-shellui-perl on Ubuntu 12.10
It is recommended that you install C<Term::ReadLine::Gnu> which will
provide more fluid signal handling on Unix-like systems, making kpcli
robust to suspend, resume, and interrupt - SIGSTP, SIGCONT and SIGINT.
That module is in the libterm-readline-gnu-perl package on Ubuntu.
You can optionally install C<Term::ReadLine::Perl5>, which is often
preferred on platforms without GNU readline (MacOS, Windows, etc.)
You can optionally install C<Clipboard> and C<Tiny::Capture> to use the
clipboard features; http://search.cpan.org/~king/Clipboard/ and
libcapture-tiny-perl on Ubuntu 10.04.
You can optionally install C<Sub::Install> to use the --timeout feature.
You can optionally install C<Data::Password> to use the pwck feature
(Password Quality Check); libdata-password-perl on Ubuntu 10.04.
You can optionally install C<Data::Password::passwdqc>, which is preferred
by the pwck feature if it is available. That module is not commonly
packaged and its list of dependencies is quite long, but cpanminus installs
it nicely on Linux Mint. It appeared that all of its upstream dependencies
were packaged in Linux Mint and so I apt-get install'ed them first, and
then cpanminus only installed C<Data::Password::passwdqc>. Because it is a
binding to a C library, C<Data::Password::passwdqc> is much faster than
C<Data::Password> and also seems to have a bit more stict password rules.
You can optionally install C<Crypt::PWSafe3> in order to import
Password Safe v3 files (https://pwsafe.org/). The dependency list
of this module is hefty and it is not packaged in many distros, but
cpanminus installs it nicely on Linux Mint (https://cpanmin.us/).
You can optionally install C<Math::Random::ISAAC> in order to use a
more secure rand() function. Package libmath-random-isaac-perl on Debian.
On MS Windows, you can optionally install C<Win32::Console::ANSI> to get
ANSI colors in Windows cmd terminals. Strawberry Perl 5.16.2 was used
for the kpcli port to Windows and, using cpanminus, one can install all
of kpcli's dependencies, sans Term::ReadLine::Gnu which is optional for
kpcli and not supported on MS Windows.
=head1 CAVEATS AND WORDS OF CAUTION
The main author of kpcli primarily interoperability tests with KeePassX
(http://www.keepassx.org/) and primarily uses KeePass v1 (*.kdb) files.
Support for KeePass v2 (*.kdbx) files in kpcli is substantial, and many
people use it daily, but it is not the author's primary use case. It is
also the author's intent to maintain compatibility with v1 files, and so
anyone sending patches, for consideration for inclusion in future kpcli
versions, is asked to validate them with both v1 and v2 files.
=head2 Some versions of Term::ReadLine::Perl5 are incompatible
C<Term::ReadLine::Perl5> versions 1.39-1.42 are incompatible with the
C<Term::ShellUI> module, which is core to kpcli. There is information about
this in kpcli SF bug #18 (http://sourceforge.net/p/kpcli/bugs/18/). The
C<Term::ReadLine::Perl5> author submitted a C<Term::ShellUI> patch to
resolve the issue (https://rt.cpan.org/Ticket/Display.html?id=105375) and
he also released C<Term::ReadLine::Perl5> version 1.43 which resolves it.
=head2 No history tracking for KeePass 2 (*.kdbx) files
Recording entries' history in KeePass 2 files is not implemented. History
that exists in a file is not destroyed, but results of entry changes made
in kpcli are not recorded into their history. Prior-to-change copies are
stored into the "Recycle Bin." Note that File::KeePass does not encrypt
passwords of history entries in RAM, like it does for current entries.
This is a small security risk that can, in theory, allow privileged users
to steal your passwords from RAM, from entry history.
=head2 File::KeePass bug prior to version 2.03
Prior to version 2.03, File::KeePass had a bug related to some "unknown"
data that KeePassX stores in group records. For File::KeePass < v2.03,
kpcli deletes those unknown data when saving. Research in the libkpass
(http://libkpass.sourceforge.net/) source code revealed that what early
versions of File::KeePass classifies as "unknown" are the times for
created/modified/accessed/expires as well as "flags" (id=9), but only for
groups; File::KeePass handled those fields just fine for entries. I found
no ill-effect from dropping those fields when saving and so that is what
kpcli does to work around the File::KeePass bug, if kpcli is using
File::KeePass < v2.03.
=head1 BUGS
=head2 Using Ctrl-D to Exit
Versions of Term::ShellUI prior to v0.9. do not have the ability to trap
Ctrl-D exits by the client program. I submitted a patch to remedy that and
it made it into Term::ShellUI v0.9. Please upgrade if kpcli asks you to.
=head2 Multiple Entries or Groups With the Same Name in the Same Group
This program does not support multiple entries in the same group having
the exact same name, nor does it support multiple groups at the same
level having the same name, and it likely never will. KeepassX does
support those. This program detects and alert when an opened database
file has those issues, but it does not refuse to save (overwrite) a file
that is opened like that. Saves are actually safe (no data loss) as long
as the user has not touched one of the duplicately-named items.
=head1 AUTHOR
Lester Hightower <hightowe at cpan dot org>
=head1 LICENSE
This program may be distributed under the same terms as Perl itself.
=head1 CREDITS
Special thanks to Paul Seamons, author of C<File::KeePass>, and to
Scott Bronson, author of C<Term::ShellUI>. Without those two modules
this program would not have been practical for me to author.
=head1 CHANGELOG
2010-Nov-28 v0.1 - Initial release.
2010-Nov-28 v0.2 - Encrypt the master password in RAM.
2010-Nov-29 v0.3 - Fixed master password encryption for saveas.
2010-Nov-29 v0.4 - Fixed code to work w/out Term::ReadLine::Gnu.
Documented File::KeePass v0.1 hierarchy bug.
2010-Nov-29 v0.5 - Made find command case insensitive.
Bugfix in new command (path regex problem).
2010-Nov-29 v0.6 - Added lock file support; warn if a lock exists.
2010-Dec-01 v0.7 - Further documented the group fields that are
dropped, in the CAVEATS section of the POD.
Sort group and entry titles naturally.
2010-Dec-23 v0.8 - Worked with File::KeePass author to fix a couple
of bugs and then required >=v0.03 of that module.
Sorted "/_found" to last in the root group list.
Fixed a "database changed" state bug in cli_save().
Made the find command ignore entries in /Backup/.
Find now offers show when only one entry is found.
Provided a patch to Term::ShellUI author to add
eof_exit_hook and added support for it to kpcli.
2011-Feb-19 v0.9 - Fixed bugs related to spaces in group names as
reported in SourceForge bug number 3132258.
The edit command now prompts to save on changes.
Put scrub_unknown_values_from_all_groups() calls
back into place after realizing that v0.03 of
File::KeePass did not resolve all of the problems.
2011-Apr-23 v1.0 - Changed a perl 5.10+ regex to a backward-compatable
one to resolve SourceForge bug number 3192413.
Modified the way that the /Backup group is ignored
by the find command to stop kpcli from croaking on
multiple entries with the same name in that group.
- Note: There is a more general bug here that
needs addressing (see BUGS section).
An empty title on new entry aborts the new entry.
Changed kdb files are now detected/warned about.
Tested against Term::ShellUI v0.9, which has my EOF
hook patch, and updated kpcli comments about it.
Term::ShellUI's complete_history() method was
removed between v0.86 and v0.9 and so I removed
kpli's call to it (Ctrl-r works for history).
Added the "icons" command.
2011-Sep-07 v1.1 - Empty DBs are now initialized to KeePassX style.
Fixed a couple of bugs in the find command.
Fixed a password noecho bug in the saveas command.
Fixed a kdb_has_changed bug in the saveas command.
Fixed a cli_open bug where it wasn't cli_close'ing.
Fixed variable init bugs in put_master_passwd().
Fixed a false warning in warn_if_file_changed().
2011-Sep-30 v1.2 - Added the "export" command.
Added the "import" command.
Command "rmdir" asks then deletes non-empty groups.
Command "new" can auto-generate random passwords.
2012-Mar-03 v1.3 - Fixed bug in cl command as reported in SourceForge
bug number 3496544.
2012-Apr-17 v1.4 - Added key file support based on a user contributed
patch with SourceForge ID# 3518388.
Added my_help_call() to allow for longer and more
descriptive command summaries (for help command).
Stopped allowing empty passwords for export.
2012-Oct-13 v1.5 - Fixed "help <foo>" commands, that I broke in v1.4.
Command "edit" can auto-generate random passwords.
Added the "cls" and "clear" commands from a patch
with SourceForge ID# 3573930.
Tested compatibility with File::KeePass v2.03 and
made minor changes that are possible with >=2.01.
With File::KeePass v2.03, kpcli should now support
KeePass v2 files (*.kdbx).
2012-Nov-25 v1.6 - Hide passwords (red on red) in the show command
unless the -f option is given.
Added the --readonly command line option.
Added support for multi-line notes/comments;
input ends on a line holding a single ".".
2013-Apr-25 v1.7 - Patched to use native File::KeePass support for key
files, if the File::KeePass version is new enough.
Added the "version" and "ver" commands.
Updated documentation as Ubuntu 12.10 now packages
all of kpcli's dependencies.
Added --histfile command line option.
Record modified times on edited records, from a
patch with SourceForge ID# 3611713.
Added the -a option to the show command.
2013-Jun-09 v2.0 - Removed the unused Clone module after a report that
Clone is no longer in core Perl as of v5.18.0.
Added the stats and pwck commands.
Added clipboard commands (xw/xu/xp/xx).
Fixed some long-standing tab completion bugs.
Warn if multiple groups or entries are titled the
same within a group, except for /Backup entries.
2013-Jun-10 v2.1 - Fixed several more tab completion bugs, and they
were serious enough to warrant a quick release.
2013-Jun-16 v2.2 - Trap and handle SIGINT (^C presses).
Trap and handle SIGTSTP (^Z presses).
Trap and handle SIGCONT (continues after ^Z).
Stopped printing found dictionary words in pwck.
2013-Jul-01 v2.3 - More readline() and signal handling improvements.
Title conflict checks in cli_new()/edit()/mv().
Group title conflict checks in rename().
cli_new() now accepts optional path&|title param.
cli_ls() can now list multiple paths.
cli_edit() now shows the "old" values for users
to edit, if Term::ReadLine::Gnu is available.
cli_edit() now aborts all changes on ^C.
cli_saveas() now asks before overwriting a file.
2013-Nov-26 v2.4 - Fixed several "perl -cw" warnings reported on
2013-07-09 as SourceForge bug #9.
Bug fix for the cl command, but in sub cli_ls().
First pass at Strawberry perl/MS Windows support.
- Enhanced support for Term::ReadLine::Perl
- Added support for Term::ReadLine::Perl5
Added display of expire time for show -a.
Added -a option to the find command.
Used the new magic_file_type() in a few places.
Added generatePasswordFromDict() and "w" generation.
Added the -v option to the version command.
- Added the versions command.
2014-Mar-15 v2.5 - Added length control (gNN) to password generation.
Added the copy command (and cp alias).
Added the clone command.
Added optional modules not installed to version -v.
Groups can now also be moved with the mv command.
Modified cli_cls() to also work on MS Windows.
Suppressed Term::ReadLine::Gnu hint on MS Windows.
Suppressed missing termcap warning on MS Windows.
Print a min number of *s to not leak passwd length.
Removed unneeded use of Term::ReadLine.
Quieted "inherited AUTOLOAD for non-method" warns
caused by Term::Readline::Gnu on perl 5.14.x.
2014-Jun-06 v2.6 - Added interactive password generation ("i" method).
- Thanks to Florian Tham for the idea and patch.
Show entry's tags if present (KeePass >= v2.11).
- Thanks to Florian Tham for the patch.
Add/edit support for tags if a v2 file is opened.
Added tags to the searched fields for "find -a".
Show string fields (key/val pairs) in v2 files.
Add/edit for string fields if a v2 file is opened.
Show information about entries' file attachments.
2014-03-20 SourceForge feature request #6.
New "attach" command to manage file attachments.
Added "Recycle Bin" functionality and --no-recycle.
For --readonly, don't create a lock file and don't
warn if one exists. 2014-03-27 SourceForge bug #11.
Added key file generation to saveas and export.
2014-04-19 SourceForge bug #13.
Added -expired option to the find command.
Added "dir" as an alias for "ls"
Added some additional info to the stats command.
Added more detailed OS info for Linux/Win in vers.
Now hides Meta-Info/SYSTEM entries.
Fixed bug with SIGTSTP handling (^Z presses).
Fixed missing refresh_state_all_paths() in cli_rm.
2014-Jun-11 v2.7 - Bug fix release. Broke the open command in 2.6.
2015-Feb-08 v2.8 - Fixed cli_copy bug; refresh paths and ask to save.
Fixed a cli_mv bug; double path-normalization.
Fixed a path display bug, if done after a cli_mv.
Protect users from editing in the $FOUND_DIR.
Keep file opened, read-only, to show up in lsof.
Added inactivity locking (--timeout parameter).
Added shell expansion support to cli_ls, with the
ability to manage _all_ listed entries by number.
Added shell expansion support to cli_mv.
Added [y/N] option to list entries after a find.
2015-Jun-19 v3.0 - Added Password Safe v3 file importing; requires
optional Crypt::PWSafe3 from CPAN.
Added $FORCED_READLINE global variable.
Attachments sanity check; SourceForge bug #17.
Endianness fix in magic_file_type(); SF bug #19.
2016-Jul-30 v3.1 - Added the purge command.
Added Data::Password::passwdqc support to the
pwck command and prefer it over Data::Password.
Minor improvements in cli_pwck().
Applied SF patch #6 from Chris van Marle.
Addressed items pointed out in SF patch #7.
In cli_save(), worked around a File::KeePass bug.
- rt.cpan.org tik# 113391; https://goo.gl/v65HKE
Applied SF patch #8 from Maciej Grela.
Optional better RNG; SF bug #30 from Aaron Toponce.
=head1 TODO ITEMS
Consider adding /shadow_copies/<entries> feature, where kpcli
will write "shadow copies" of the database, one for each entry,
using the path/password in the url/password fields.
Consider broadening shell_expansion support beyond just mv and ls.
Consider adding a tags command for use with v2 files.
- To navigate by entry tags
Consider supporting KeePass 2.x style entry history.
- There are potential security implications in File::KeePass.
- Related, consider adding a purge command for that history.
Consider adding KeePass 2.x style multi-user synchronization.
Consider adding searches for created, modified, and accessed times
older than a user supplied time.
=head1 OPERATING SYSTEMS AND SCRIPT CATEGORIZATION
=pod OSNAMES
Unix-like
- Originally written and tested on Ubuntu Linux 10.04.1 LTS.
- As of version 3.0, development is done on Linux Mint 17.
- Known to work on many other Linux and *BSD distributions, and
kpcli is packaged with many distributions now-a-days.
Microsoft Windows
- As of v2.4, Microsoft Windows is also supported.
- Tested and compiled on Strawberry Perl 5.16.2 on Windows 7.
=pod SCRIPT CATEGORIES
C<UNIX/System_administration>, C<Win32/Utilities>
|