PoshKeePass/PoShKeePass.psm1
|
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 |
function ConvertTo-KPPSObject { <# .SYNOPSIS This Function will accept KeePass Entry Objects and Convert them to a Powershell Object for Ease of Use. .DESCRIPTION This Function will accept KeePass Entry Objects and Convert them to a Powershell Object for Ease of Use. It will get the Protected Strings from the database like, Title,UserName,Password,URL,Notes. It currently returns Most frequently used data about an entry and excludes extensive metadata such as- Foreground Color, Icon, ect. .EXAMPLE PS> ConvertTo-KPPsObject -KeePassEntry $Entry This Example Converts one or more KeePass Entries to a defined Powershell Object. .EXAMPLE PS> Get-KeePassEntry -KeePassonnection $DB -UserName "AUserName" | ConvertTo-KeePassPsObject This Example Converts one or more KeePass Entries to a defined Powershell Object. .PARAMETER KeePassEntry This is the one or more KeePass Entries to be converted. #> [CmdletBinding(DefaultParameterSetName = 'Entry')] [OutputType([PSCustomObject])] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName, ParameterSetName = 'Entry')] [ValidateNotNullOrEmpty()] [KeePassLib.PwEntry[]] $KeePassEntry, [Parameter(Position = 0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName, ParameterSetName = 'Group')] [ValidateNotNullOrEmpty()] [KeePassLib.PwGroup[]] $KeePassGroup, [Parameter(Position = 1, ParameterSetName = 'Entry')] [switch] $WithCredential, [Parameter(Position = 2, ParameterSetName = 'Entry')] [switch] $AsPlainText, [Parameter(Position = 3, ValueFromPipelineByPropertyName)] [string] $DatabaseProfileName ) process { if($PSCmdlet.ParameterSetName -eq 'Entry') { foreach ($_keepassItem in $KeePassEntry) { if($WithCredential) { try { $Credential = New-Object -TypeName PSCredential -ArgumentList @($_keepassItem.Strings.ReadSafe('UserName'), ($_keepassItem.Strings.ReadSafe('Password') | ConvertTo-SecureString -AsPlainText -Force -ea SilentlyContinue)) } catch{} } if($AsPlainText) { $Password = $_keepassItem.Strings.ReadSafe('Password') } else { $Password = $_keepassItem.Strings.ReadSafe('Password') | ConvertTo-SecureString -AsPlainText -Force -ea SilentlyContinue } $KeePassPsObject = New-Object -TypeName PSObject -Property ([ordered]@{ 'Uuid' = $_keepassItem.Uuid; 'CreationTime' = $_keepassItem.CreationTime; 'Expires' = $_keepassItem.Expires; 'ExpireTime' = $_keepassItem.ExpiryTime; 'LastAccessTimeUtc' = $_keepassItem.LastAccessTime; 'LastModificationTimeUtc' = $_keepassItem.LastModificationTime; 'LocationChanged' = $_keepassItem.LocationChanged; 'Tags' = $_keepassItem.Tags; 'Touched' = $_keepassItem.Touched; 'UsageCount' = $_keepassItem.UsageCount; 'ParentGroup' = $_keepassItem.ParentGroup.Name; 'FullPath' = $_keepassItem.ParentGroup.GetFullPath('/', $true); 'Title' = $_keepassItem.Strings.ReadSafe('Title'); 'UserName' = $_keepassItem.Strings.ReadSafe('UserName'); 'Password' = $Password 'URL' = $_keepassItem.Strings.ReadSafe('URL'); 'Notes' = $_keepassItem.Strings.ReadSafe('Notes'); 'IconId' = $_keepassItem.IconId; 'Credential' = $Credential; 'DatabaseProfileName' = $DatabaseProfileName; 'KPEntry' = $_keepassItem; }) ## Custom Object Formatting and Type $KeePassPsObject.PSObject.TypeNames.Insert(0, 'PSKeePass.Entry') $KeePassPsObject if($Password){ Remove-Variable -Name 'Password' } } } elseif($PSCmdlet.ParameterSetName -eq 'Group') { foreach ($_keepassItem in $KeePassGroup) { if($_keepassItem.ParentGroup.Name) { $FullPath = $_keepassItem.ParentGroup.GetFullPath('/', $true) } else { $FullPath = '' } $KeePassPsObject = New-Object -TypeName PSObject -Property ([ordered]@{ 'Uuid' = $_keepassItem.Uuid; 'Name' = $_keepassItem.Name; 'CreationTime' = $_keepassItem.CreationTime; 'Expires' = $_keepassItem.Expires; 'ExpireTime' = $_keepassItem.ExpiryTime; 'LastAccessTimeUtc' = $_keepassItem.LastAccessTime; 'LastModificationTimeUtc' = $_keepassItem.LastModificationTime; 'LocationChanged' = $_keepassItem.LocationChanged; 'Notes' = $_keepassItem.Notes; 'Touched' = $_keepassItem.Touched; 'UsageCount' = $_keepassItem.UsageCount; 'ParentGroup' = $_keepassItem.ParentGroup.Name; 'FullPath' = $_keepassItem.GetFullPath('/', $true); 'Groups' = $_keepassItem.Groups; 'EntryCount' = $_keepassItem.Entries.Count; 'IconId' = $_keepassItem.IconId; 'DatabaseProfileName' = $DatabaseProfileName; 'KPGroup' = $_keepassItem; }) ## Custom Object Formatting and Type $KeePassPsObject.PSObject.TypeNames.Insert(0, 'PSKeePass.Group') $PSKeePassGroupDisplaySet = 'Name', 'EntryCount', 'FullPath', 'IconId' $PSKeePassGroupDefaultPropertySet = New-Object -TypeName System.Management.Automation.PSPropertySet('DefaultDisplayPropertySet', [String[]] $PSKeePassGroupDisplaySet) $PSKeePassGroupStandardMembers = [System.Management.Automation.PSMemberInfo[]] @($PSKeePassGroupDefaultPropertySet) $KeePassPsObject | Add-Member MemberSet PSStandardMembers $PSKeePassGroupStandardMembers $KeePassPsObject } } } end { if($Credential){ Remove-Variable -Name 'Credential' } } } function Get-KeePassDatabaseConfiguration { <# .SYNOPSIS Function to Retrieve a or all KeePass Database Configuration Profiles saved to the KeePassConfiguration.xml file. .DESCRIPTION Function to Retrieve a or all KeePass Database Configuration Profiles saved to the KeePassConfiguration.xml file. .PARAMETER DatabaseProfileName Specify the name of the profile to lookup. .EXAMPLE PS> Get-KeePassDatabaseConfiguration This Example will return all Database Configuration Profiles if any. .EXAMPLE PS> Get-KeePassDatabaseConfiguration -DatabaseProfileName 'Personal' This Example returns the Database Configuration Profile with the name Personal. .INPUTS Strings .OUTPUTS PSObject #> [CmdletBinding(DefaultParameterSetName = '__None')] param ( [Parameter(Position = 0, ParameterSetName = '__Profile')] [ValidateNotNullOrEmpty()] [String] $DatabaseProfileName, [Parameter(Position = 1, ParameterSetName = '__DefaultDB')] [ValidateNotNullOrEmpty()] [Switch] $Default, [Parameter(Position = 2)] [Switch] $Stop ) process { if(Test-Path -Path $SCRIPT:KeePassConfigurationFile) { [Xml] $XML = New-Object -TypeName System.Xml.XmlDocument $XML.Load($SCRIPT:KeePassConfigurationFile) if($DatabaseProfileName) { $ProfileResults = $XML.Settings.DatabaseProfiles.Profile | Where-Object { $_.Name -ilike $DatabaseProfileName } } elseif($Default) { $ProfileResults = $XML.Settings.DatabaseProfiles.Profile | Where-Object { $_.Default -ieq 'true' } if($Stop -and -not $ProfileResults) { throw 'Unable to find a default KeePass Configuration, please specify a database profile name or set a default profile.' } } else { $ProfileResults = $XML.Settings.DatabaseProfiles.Profile } if(-not $ProfileResults -and $Stop) { throw 'InvalidKeePassConfiguration : No KeePass Configuration has been created.' } foreach($ProfileResult in $ProfileResults) { $UseNetworkAccount = if($ProfileResult.UseNetworkAccount -eq 'True'){$true}else{$false} $UseMasterKey = if($ProfileResult.UseMasterKey -eq 'True'){$true}else{$false} $ProfileDefault = if($ProfileResult.Default -eq 'True'){$true}else{$false} [hashtable] $ProfileObject = [ordered]@{ 'Name' = $ProfileResult.Name; 'DatabasePath' = $ProfileResult.DatabasePath; 'KeyPath' = $ProfileResult.KeyPath; 'UseMasterKey' = $UseMasterKey; 'UseNetworkAccount' = $UseNetworkAccount; 'AuthenticationType' = $ProfileResult.AuthenticationType; 'Default' = $ProfileDefault; } New-Object -TypeName PSObject -Property $ProfileObject } } else { Write-Warning 'The specified KeePass Configuration does not exist.' } } } function Get-KeePassEntry { <# .SYNOPSIS Function to get keepass database entries. .DESCRIPTION This Funciton gets all keepass database entries or a specified group/folder subset if the -KeePassEntryGroupPath parameter is Specified. .PARAMETER KeePassEntryGroupPath Specify this parameter if you wish to only return entries form a specific folder path. Notes: * Path Separator is the forward slash character '/' .PARAMETER AsPlainText Specify this parameter if you want the KeePass database entries to be returns in plain text objects. .PARAMETER DatabaseProfileName *This Parameter is required in order to access your KeePass database. .PARAMETER MasterKey Specify a SecureString MasterKey if necessary to authenticat a keepass databse. If not provided and the database requires one you will be prompted for it. This parameter was created with scripting in mind. .PARAMETER AsPSCredential Output Entry as an PSCredential Object .EXAMPLE PS> Get-KeePassEntry -DatabaseProfileName TEST -AsPlainText This Example will return all enties in plain text format from that keepass database that was saved to the config with the name TEST. .EXAMPLE PS> Get-KeePassEntry -DatabaseProfileName TEST -KeePassEntryGroupPath 'General' -AsPlainText This Example will return all entries in plain text format from the General folder of the keepass database with the profile name TEST. .EXAMPLE PS> Get-KeePassEntry -DatabaseProfileName TEST -Title test -AsPSCredential This Example will return one entry as PSCredential Object .INPUTS String .OUTPUTS PSObject #> [CmdletBinding()] param ( [Parameter(Position = 0, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('FullPath')] [String] $KeePassEntryGroupPath, [Parameter(Position = 1, ValueFromPipelineByPropertyName)] [String] $Title, [Parameter(Position = 2)] [string] $UserName, [Parameter(Position = 3)] [Switch] $AsPlainText, [Parameter(Position = 4)] [Alias('AsPSCredential')] [Switch] $WithCredential, [Parameter(Position = 5, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [string] $DatabaseProfileName, [Parameter(Position = 6)] [ValidateNotNullOrEmpty()] [PSobject] $MasterKey ) begin { } process { $KeePassConnectionObject = New-KPConnection -DatabaseProfileName $DatabaseProfileName -MasterKey $MasterKey Remove-Variable -Name MasterKey -ea 0 [hashtable] $params = @{ 'KeePassConnection' = $KeePassConnectionObject; } if($KeePassEntryGroupPath) { $KeePassGroup = Get-KpGroup -KeePassConnection $KeePassConnectionObject -FullPath $KeePassEntryGroupPath -Stop $params.KeePassGroup = $KeePassGroup } if($Title){ $params.Title = $Title } if($UserName){ $params.UserName = $UserName } Get-KPEntry @params | ConvertTo-KpPsObject -AsPlainText:$AsPlainText -WithCredential:$WithCredential -DatabaseProfileName $DatabaseProfileName } end { Remove-KPConnection -KeePassConnection $KeePassConnectionObject } } function Get-KeePassGroup { <# .SYNOPSIS Function to get keepass database entries. .DESCRIPTION This Funciton gets all keepass database entries or a specified group/folder subset if the -KeePassEntryGroupPath parameter is Specified. .PARAMETER KeePassGroupPath Specify this parameter if you wish to only return entries form a specific folder path. Notes: * Path Separator is the foward slash character '/' .PARAMETER AsPlainText Specify this parameter if you want the KeePass database entries to be returns in plain text objects. .PARAMETER DatabaseProfileName *This Parameter is required in order to access your KeePass database. .PARAMETER MasterKey Specify a SecureString MasterKey if necessary to authenticat a keepass databse. If not provided and the database requires one you will be prompted for it. This parameter was created with scripting in mind. .EXAMPLE PS> Get-KeePassGroup -DatabaseProfileName TEST -AsPlainText This Example will return all groups in plain text format from that keepass database that was saved to the config with the name TEST. .EXAMPLE PS> Get-KeePassGroup -DatabaseProfileName TEST -KeePassGroupPath 'General' -AsPlainText This Example will return all groups in plain text format from the General folder of the keepass database with the profile name TEST. .INPUTS String .OUTPUTS PSObject #> [CmdletBinding()] param ( [Parameter(Position = 0, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('FullPath')] [String] $KeePassGroupPath, [Parameter(Position = 1)] [Switch] $AsPlainText, [Parameter(Position = 2, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [string] $DatabaseProfileName, [Parameter(Position = 3)] [ValidateNotNullOrEmpty()] [PSobject] $MasterKey ) begin { if($AsPlainText) { Write-Warning -Message 'The -AsPlainText switch parameter is deprecated and will be removed by end of year 2018!' } } process { $KeePassConnectionObject = New-KPConnection -DatabaseProfileName $DatabaseProfileName -MasterKey $MasterKey Remove-Variable -Name MasterKey -ea 0 [hashtable] $getKpGroupSplat = @{ 'KeePassConnection' = $KeePassConnectionObject } if($KeePassGroupPath) { $getKpGroupSplat.FullPath = $KeePassGroupPath } Get-KPGroup @getKpGroupSplat | ConvertTo-KpPsObject -DatabaseProfileName $DatabaseProfileName } end { Remove-KPConnection -KeePassConnection $KeePassConnectionObject } } function New-KeePassDatabase { <# .SYNOPSIS Function to create a keepass database. .DESCRIPTION This function creates a new keepass database .PARAMETER DatabasePath Path to the Keepass database (.kdbx file) .PARAMETER KeyPath Not yet implemented .PARAMETER MasterKey The masterkey that provides access to the database .INPUTS String SecureString .OUTPUTS $null #> [CmdletBinding()] param ( [Parameter(Position = 0)] [ValidateNotNullOrEmpty()] [String] $DatabasePath, [Parameter(Position = 1, Mandatory, ParameterSetName = 'Key')] [Parameter(Position = 1, Mandatory, ParameterSetName = 'KeyAndMaster')] [ValidateNotNullOrEmpty()] [ValidateScript({Test-Path $_})] [String] $KeyPath, # [Parameter(Position = 2, ParameterSetName = 'Key')] # [Parameter(Position = 2, ParameterSetName = 'Master')] # [Parameter(Position = 2, Mandatory, ParameterSetName = 'Network')] # [Switch] $UseNetworkAccount, [Parameter(Position = 3, Mandatory, ParameterSetName = 'Master')] [Parameter(Position = 3, Mandatory, ParameterSetName = 'KeyAndMaster')] [PSCredential] $MasterKey ) begin { if($KeyPath) { throw "KeyPath is not implemented yet" } } process { if(Test-Path -Path $DatabasePath) { throw ('The specified Database Path already exists: {0}.' -f $DatabasePath) } else { try { $DatabaseObject = New-Object -TypeName KeepassLib.PWDatabase -ErrorAction Stop } catch { Import-KPLibrary $DatabaseObject = New-Object -TypeName KeepassLib.PWDatabase -ErrorAction Stop } $CompositeKey = New-Object -TypeName KeepassLib.Keys.CompositeKey if($MasterKey) { $KcpPassword = New-Object -TypeName KeePassLib.Keys.KcpPassword($MasterKey.GetNetworkCredential().Password) $CompositeKey.AddUserKey($KcpPassword) } if($UseNetworkAccount) { $CompositeKey.AddUserKey((New-Object KeepassLib.Keys.KcpUserAccount)) } $IOInfo = New-Object KeepassLib.Serialization.IOConnectionInfo $IOInfo.Path = $DatabasePath $IStatusLogger = New-Object KeePassLib.Interfaces.NullStatusLogger $DatabaseObject.New($IOInfo, $CompositeKey) | Out-Null $DatabaseObject.Save($IStatusLogger) } } } function New-KeePassDatabaseConfiguration { <# .SYNOPSIS Function to Create or Add a new KeePass Database Configuration Profile to the KeePassConfiguration.xml .DESCRIPTION The Profile Created will be accessible from the core functions Get,Update,New,Remove KeePassEntry and ect. The Profile stores database configuration for opening and authenticating to a keepass database. Using the configuration allows for speedier authentication and less complex commands. .PARAMETER DatabaseProfileName Specify the Name of the new Database Configuration Profile. .PARAMETER DatabasePath Specify the Path to the database (.kdbx) file. .PARAMETER KeyPath Specify the Path to the database (.key) key file if there is one. .PARAMETER UseMasterKey Specify this flag if the database uses a Master Key Password for Authentication. .PARAMETER PassThru Specify to return the new database configuration profile object. .EXAMPLE PS> New-KeePassDatabaseConfiguration -DatabaseProfileName 'Personal' -DatabasePath 'c:\users\username\documents\personal.kdbx' -KeyPath 'c:\users\username\documents\personal.key' -UseNetworkAccount This Example adds a Database Configuration Profile to the KeePassConfiguration.xml file with the Name Personal specifying the database file and authentication components; Key File and Uses NetworkAccount. .EXAMPLE PS> New-KeePassDatabaseConfiguration -DatabaseProfileName 'Personal' -DatabasePath 'c:\users\username\documents\personal.kdbx' -UseNetworkAccount This Example adds a Database Configuration Profile to the KeePassConfiguration.xml file with the Name Personal specifying the database file and authentication components; Uses NetworkAccount. .NOTES 1. Currently all authentication combinations are supported except keyfile, masterkey password, and network authentication together. .INPUTS Strings .OUTPUTS $null #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory)] [ValidateNotNullOrEmpty()] [String] $DatabaseProfileName, [Parameter(Position = 1, Mandatory, ParameterSetName = 'Key')] [Parameter(Position = 1, Mandatory, ParameterSetName = 'Master')] [Parameter(Position = 1, Mandatory, ParameterSetName = 'Network')] [Parameter(Position = 1, Mandatory, ParameterSetName = 'KeyAndMaster')] [ValidateNotNullOrEmpty()] [ValidateScript({Test-Path $_})] [String] $DatabasePath, [Parameter(Position = 2, Mandatory, ParameterSetName = 'Key')] [Parameter(Position = 2, Mandatory, ParameterSetName = 'KeyAndMaster')] [ValidateNotNullOrEmpty()] [ValidateScript({Test-Path $_})] [String] $KeyPath, # [Parameter(Position = 3, ParameterSetName = 'Key')] # [Parameter(Position = 3, ParameterSetName = 'Master')] # [Parameter(Position = 3, ParameterSetName = 'Network')] # [Switch] $UseNetworkAccount, [Parameter(Position = 4, Mandatory, ParameterSetName = 'Master')] [Parameter(Position = 4, Mandatory, ParameterSetName = 'KeyAndMaster')] [Switch] $UseMasterKey, [Parameter(Position = 5)] [Switch] $Default, [Parameter(Position = 6)] [Switch] $PassThru ) begin { if($PSCmdlet.ParameterSetName -eq 'Network' -and -not $UseNetworkAccount) { Write-Warning -Message '[BEGIN] Please Specify a valid Credential Combination.' Write-Warning -Message '[BEGIN] You can not have a only a database file with no authentication options.' Throw 'Please Specify a valid Credential Combination.' } } process { if (-not (Test-Path -Path $SCRIPT:KeePassConfigurationFile)) { Write-Verbose -Message '[PROCESS] A KeePass Configuration File does not exist. One will be generated now.' New-KPConfigurationFile } else { $CheckIfProfileExists = Get-KeePassDatabaseConfiguration -DatabaseProfileName $DatabaseProfileName } if($CheckIfProfileExists) { Write-Warning -Message ('[PROCESS] A KeePass Database Configuration Profile Already exists with the specified name: {0}.' -f $DatabaseProfileName) Throw '[PROCESS] A KeePass Database Configuration Profile Already exists with the specified name: {0}.' -f $DatabaseProfileName } else { try { if($Default) { $defaultProfile = Get-KeePassDatabaseConfiguration -Default if($defaultProfile) { throw ('{0} profile is already set to the default, if you would like to overwrite it as the default please use the Update-KeePassDatabaseConfiguration function and remove the default flag.' -f $defaultProfile.Name) } } [Xml] $XML = New-Object -TypeName System.Xml.XmlDocument $XML.Load($SCRIPT:KeePassConfigurationFile) ## Create New Profile Element with Name of the new profile $DatabaseProfile = $XML.CreateElement('Profile') $DatabaseProfileAtribute = $XML.CreateAttribute('Name') $DatabaseProfileAtribute.Value = $DatabaseProfileName $DatabaseProfile.Attributes.Append($DatabaseProfileAtribute) | Out-Null ## Build and Add Element Nodes $DatabasePathNode = $XML.CreateNode('element', 'DatabasePath', '') $DatabasePathNode.InnerText = $DatabasePath $DatabaseProfile.AppendChild($DatabasePathNode) | Out-Null $KeyPathNode = $XML.CreateNode('element', 'KeyPath', '') $KeyPathNode.InnerText = $KeyPath $DatabaseProfile.AppendChild($KeyPathNode) | Out-Null $UseNetworkAccountNode = $XML.CreateNode('element', 'UseNetworkAccount', '') $UseNetworkAccountNode.InnerText = $UseNetworkAccount $DatabaseProfile.AppendChild($UseNetworkAccountNode) | Out-Null $UseMasterKeyNode = $XML.CreateNode('element', 'UseMasterKey', '') $UseMasterKeyNode.InnerText = $UseMasterKey $DatabaseProfile.AppendChild($UseMasterKeyNode) | Out-Null $AuthenticationTypeNode = $XML.CreateNode('element', 'AuthenticationType', '') $AuthenticationTypeNode.InnerText = $PSCmdlet.ParameterSetName $DatabaseProfile.AppendChild($AuthenticationTypeNode) | Out-Null $DefaultNode = $XML.CreateNode('element', 'Default', '') $DefaultNode.InnerText = $Default $DatabaseProfile.AppendChild($DefaultNode) | Out-Null $XML.SelectSingleNode('/Settings/DatabaseProfiles').AppendChild($DatabaseProfile) | Out-Null $XML.Save($SCRIPT:KeePassConfigurationFile) $Script:KeePassProfileNames = (Get-KeePassDatabaseConfiguration).Name if($PassThru) { Get-KeePassDatabaseConfiguration -DatabaseProfileName $DatabaseProfileName } } catch { Write-Warning -Message ('[PROCESS] An Exception Occured while trying to add a new KeePass database configuration ({0}) to the configuration file.' -f $DatabaseProfileName) Write-Warning -Message ('[PROCESS] {0}' -f $_.Exception.Message) Throw $_ } } } } function New-KeePassEntry { <# .SYNOPSIS Function to create a new KeePass Database Entry. .DESCRIPTION This function allows for the creation of KeePass Database Entries with basic properites available for specification. .PARAMETER KeePassEntryGroupPath Specify this parameter if you wish to only return entries form a specific folder path. Notes: * Path Separator is the foward slash character '/' .PARAMETER DatabaseProfileName *This Parameter is required in order to access your KeePass database. .PARAMETER Title Specify the Title of the new KeePass Database Entry. .PARAMETER UserName Specify the UserName of the new KeePass Database Entry. .PARAMETER KeePassPassword *Specify the KeePassPassword of the new KeePass Database Entry. *Notes: *This Must be of the type SecureString or KeePassLib.Security.ProtectedString .PARAMETER Notes Specify the Notes of the new KeePass Database Entry. .PARAMETER URL Specify the URL of the new KeePass Database Entry. .PARAMETER PassThru Specify to return the newly created keepass database entry. .PARAMETER MasterKey Specify a SecureString MasterKey if necessary to authenticat a keepass databse. If not provided and the database requires one you will be prompted for it. This parameter was created with scripting in mind. .PARAMETER IconName Specify the Name of the Icon for the Entry to display in the KeePass UI. .PARAMETER Expires Specify if you want the KeePass Object to Expire, default is to not expire. .PARAMETER ExpiryTime Datetime expiration Time value. .EXAMPLE PS> New-KeePassEntry -DatabaseProfileName TEST -KeePassEntryGroupPath 'General/TestAccounts' -Title 'Test Title' -UserName 'Domain\svcAccount' -KeePassPassword $(New-KeePassPassword -upper -lower -digits -length 20) This example creates a new keepass database entry in the General/TestAccounts database group, with the specified Title and UserName. Also the function New-KeePassPassword is used to generated a random password with the specified options. .EXAMPLE PS> New-KeePassEntry -DatabaseProfileName TEST -KeePassEntryGroupPath 'General/TestAccounts' -Title 'Test Title' -UserName 'Domain\svcAccount' -KeePassPassword $(New-KeePassPassword -PasswordProfileName 'Default' ) This example creates a new keepass database entry in the General/TestAccounts database group, with the specified Title and UserName. Also the function New-KeePassPassword with a password profile specifed to create a new password genereated from options saved to a profile. .EXAMPLE PS> New-KeePassEntry -DatabaseProfileName TEST -Title 'Test Title' -UserName 'Domain\svcAccount' -KeePassPassword $(ConvertTo-SecureString -String 'apassword' -AsPlainText -Force) This example creates a new keepass database entry with the specified Title, UserName and manually specified password converted to a securestring. .INPUTS String SecureString .OUTPUTS $null #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('FullPath')] [String] $KeePassEntryGroupPath, [Parameter(Position = 1)] [ValidateNotNullOrEmpty()] [String] $Title, [Parameter(Position = 2)] [ValidateNotNullOrEmpty()] [String] $UserName, [Parameter(Position = 3)] [ValidateNotNullOrEmpty()] [ValidateScript({$_.GetType().Name -eq 'ProtectedString' -or $_.GetType().Name -eq 'SecureString'})] [PSObject] $KeePassPassword, [Parameter(Position = 4)] [ValidateNotNullOrEmpty()] [String] $Notes, [Parameter(Position = 5)] [ValidateNotNullOrEmpty()] [String] $URL, [Parameter(Position = 6)] [ValidateNotNullOrEmpty()] [string] $IconName = 'Key', [Parameter(Position = 7)] [switch] $Expires, [Parameter(Position = 8)] [DateTime] $ExpiryTime, [Parameter(Position = 9, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [string] $DatabaseProfileName, [Parameter(Position = 10)] [ValidateNotNullOrEmpty()] [PSobject] $MasterKey, [Parameter(Position = 11)] [Switch] $PassThru ) begin { } process { $KeePassConnectionObject = New-KPConnection -DatabaseProfileName $DatabaseProfileName -MasterKey $MasterKey Remove-Variable -Name MasterKey -ea 0 try { $KeePassGroup = Get-KpGroup -KeePassConnection $KeePassConnectionObject -FullPath $KeePassEntryGroupPath -Stop $addKpEntrySplat = @{ URL = $URL UserName = $UserName IconName = $IconName KeePassGroup = $KeePassGroup KeePassPassword = $KeePassPassword PassThru = $PassThru Title = $Title KeePassConnection = $KeePassConnectionObject Notes = $Notes } if(Test-Bound -ParameterName 'Expires'){ $addKpEntrySplat.Expires = $Expires } if($ExpiryTime){ $addKpEntrySplat.ExpiryTime = $ExpiryTime } Add-KpEntry @addKpEntrySplat | ConvertTo-KPPSObject -DatabaseProfileName $DatabaseProfileName } catch { Throw $_ } } end { Remove-KPConnection -KeePassConnection $KeePassConnectionObject } } function New-KeePassGroup { <# .SYNOPSIS Function to create a new KeePass Database Entry. .DESCRIPTION This function allows for the creation of KeePass Database Entries with basic properites available for specification. .PARAMETER KeePassParentGroupPath Specify this parameter if you wish to only return entries form a specific folder path. Notes: * Path Separator is the foward slash character '/' .PARAMETER DatabaseProfileName *This Parameter is required in order to access your KeePass database. .PARAMETER KeePassGroupName Specify the Name of the new KeePass Group. .PARAMETER PassThru Specify to return the new group object. .PARAMETER MasterKey Specify a SecureString MasterKey if necessary to authenticat a keepass databse. If not provided and the database requires one you will be prompted for it. This parameter was created with scripting in mind. .PARAMETER IconName Specify the Name of the Icon for the Group to display in the KeePass UI. .PARAMETER Notes Specify group notes .PARAMETER Expires Specify if you want the KeePass Object to Expire, default is to not expire. .PARAMETER ExpiryTime Datetime expiration Time value. .EXAMPLE PS> New-KeePassGroup -DatabaseProfileName TEST -KeePassParentGroupPath 'General/TestAccounts' -KeePassGroupName 'TestGroup' This Example Creates a Group Called 'TestGroup' in the Group Path 'General/TestAccounts' .INPUTS Strings .OUTPUTS $null #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('FullPath')] [String] $KeePassGroupParentPath, [Parameter(Position = 1, Mandatory)] [ValidateNotNullOrEmpty()] [String] $KeePassGroupName, [Parameter(Position = 2)] [ValidateNotNullOrEmpty()] [string] $IconName = 'Folder', [Parameter(Position = 3)] [ValidateNotNullOrEmpty()] [String] $Notes, [Parameter(Position = 4)] [switch] $Expires, [Parameter(Position = 5)] [DateTime] $ExpiryTime, [Parameter(Position = 6, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [string] $DatabaseProfileName, [Parameter(Position = 7)] [ValidateNotNullOrEmpty()] [PSobject] $MasterKey, [Parameter(Position = 8)] [Switch] $PassThru ) begin { } process { $KeePassConnectionObject = New-KPConnection -DatabaseProfileName $DatabaseProfileName -MasterKey $MasterKey Remove-Variable -Name MasterKey -ea 0 $KeePassParentGroup = Get-KpGroup -KeePassConnection $KeePassConnectionObject -FullPath $KeePassGroupParentPath -Stop $addKPGroupSplat = @{ KeePassConnection = $KeePassConnectionObject GroupName = $KeePassGroupName IconName = $IconName PassThru = $PassThru KeePassParentGroup = $KeePassParentGroup Notes = $Notes } # if($Notes){ $addKPGroupSplat.Notes = $Notes } if(Test-Bound -ParameterName 'Expires'){ $addKPGroupSplat.Expires = $Expires } if($ExpiryTime){ $addKPGroupSplat.ExpiryTime = $ExpiryTime } Add-KPGroup @addKPGroupSplat | ConvertTo-KpPsObject -DatabaseProfileName $DatabaseProfileName } end { Remove-KPConnection -KeePassConnection $KeePassConnectionObject } } function New-KeePassPassword { <# .SYNOPSIS This Function will Generate a New Password. .DESCRIPTION This Function will Generate a New Password with the Specified rules using the KeePass- Password Generator. This Contains the Majority of the Options including the advanced options that the KeePass- UI provides in its "PasswordGenerator Form". Currently this function does not support the use of previously saved/created Password Profiles- aka KeePassLib.Security.PasswordGenerator.PwProfile. Nore does it support Saving a New Profile. This Simply Applies the Rules specified and generates a new password that is returned in the form- of a KeePassLib.Security.ProtectedString. .EXAMPLE PS> New-KeePassPassword This Example will generate a Password using the Default KeePass Password Profile. Which is is -UpperCase -LowerCase -Digites -Length 20 .EXAMPLE PS> New-KeePassPassword -UpperCase -LowerCase -Digits -Length 20 This Example will generate a 20 character password that contains Upper and Lower case letters ans numbers 0-9 .EXAMPLE PS> New-KeePassPassword -UpperCase -LowerCase -Digits -Length 20 -SaveAs 'Basic Password' This Example will generate a 20 character password that contains Upper and Lower case letters ans numbers 0-9. Then it will save it as a password profile with the bane 'Basic Password' for future reuse. .EXAMPLE PS> New-KeePassPassword -PasswordProfileName 'Basic Password' This Example will generate a password using the password profile name Basic Password. .EXAMPLE PS> New-KeePassPassword -UpperCase -LowerCase -Digits -SpecialCharacters -ExcludeCharacters '"' -Length 20 This Example will generate a Password with the Specified Options and Exclude the Double Quote Character .PARAMETER UpperCase If Specified it will add UpperCase Letters to the character set used to generate the password. .PARAMETER LowerCase If Specified it will add LowerCase Letters to the character set used to generate the password. .PARAMETER Digits If Specified it will add Digits to the character set used to generate the password. .PARAMETER SpecialCharacters If Specified it will add Special Characters '!"#$%&''*+,./:;=?@\^`|~' to the character set used to generate the password. .PARAMETER Minus If Specified it will add the Minus Symbol '-' to the character set used to generate the password. .PARAMETER UnderScore If Specified it will add the UnderScore Symbol '_' to the character set used to generate the password. .PARAMETER Space If Specified it will add the Space Character ' ' to the character set used to generate the password. .PARAMETER Brackets If Specified it will add Bracket Characters '()<>[]{}' to the character set used to generate the password. .PARAMETER ExcludeLookAlike If Specified it will exclude Characters that Look Similar from the character set used to generate the password. .PARAMETER NoRepeatingCharacters If Specified it will only allow Characters exist once in the password that is returned. .PARAMETER ExcludeCharacters This will take a list of characters to Exclude, and remove them from the character set used to generate the password. .PARAMETER Length This will specify the length of the resulting password. If not used it will use KeePass's Default Password Profile Length Value which I believe is 20. .PARAMETER SaveAS Specify the name in which you wish to save the password configuration as. This will save all specified settings the KeePassConfiguration.xml file, which can then be specifed later when genreating a password to match the same settings. .PARAMETER PasswordProfileName *Specify this parameter to use a previously saved password profile to genreate a password. *Note: *This supports Tab completion as it will get all saved profiles. .INPUTS String Switch .OUTPUTS KeePassLib.Security.ProtectedString #> [CmdletBinding(DefaultParameterSetName = 'NoProfile')] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "PasswordProfileName")] param ( [Parameter(Position = 0, Mandatory, ParameterSetName = 'Profile')] [ValidateNotNullOrEmpty()] [String] $PasswordProfileName, [Parameter(Position = 0, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $UpperCase, [Parameter(Position = 1, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $LowerCase, [Parameter(Position = 2, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $Digits, [Parameter(Position = 3, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $SpecialCharacters, [Parameter(Position = 4, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $Minus, [Parameter(Position = 5, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $UnderScore, [Parameter(Position = 6, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $Space, [Parameter(Position = 7, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $Brackets, [Parameter(Position = 8, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $ExcludeLookALike, [Parameter(Position = 9, ParameterSetName = 'NoProfile')] [ValidateNotNull()] [Switch] $NoRepeatingCharacters, [Parameter(Position = 10, ParameterSetName = 'NoProfile')] [ValidateNotNullOrEmpty()] [String] $ExcludeCharacters, [Parameter(Position = 11, ParameterSetName = 'NoProfile')] [ValidateNotNullOrEmpty()] [Int] $Length, [Parameter(Position = 12, ParameterSetName = 'NoProfile')] [ValidateNotNullOrEmpty()] [String] $SaveAs ) begin { } process { ## Create New Password Profile. $PassProfile = New-Object KeePassLib.Cryptography.PasswordGenerator.PwProfile if($PSCmdlet.ParameterSetName -eq 'NoProfile') { $NewProfileObject = '' | Select-Object ProfileName, CharacterSet, ExcludeLookAlike, NoRepeatingCharacters, ExcludeCharacters, Length if($PSBoundParameters.Count -gt 0) { $PassProfile.CharSet = New-Object KeePassLib.Cryptography.PasswordGenerator.PwCharSet if($UpperCase) { $NewProfileObject.CharacterSet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' } if($LowerCase) { $NewProfileObject.CharacterSet += 'abcdefghijklmnopqrstuvwxyz' } if($Digits) { $NewProfileObject.CharacterSet += '0123456789' } if($SpecialCharacters) { $NewProfileObject.CharacterSet += '!"#$%&''*+,./:;=?@\^`|~' } if($Minus) { $NewProfileObject.CharacterSet += '-' } if($UnderScore) { $NewProfileObject.CharacterSet += '_' } if($Space) { $NewProfileObject.CharacterSet += ' ' } if($Brackets) { $NewProfileObject.CharacterSet += '[]{}()<>' } if($ExcludeLookALike) { $NewProfileObject.ExcludeLookAlike = $true } else { $NewProfileObject.ExcludeLookAlike = $false } if($NoRepeatingCharacters) { $NewProfileObject.NoRepeatingCharacters = $true } else { $NewProfileObject.NoRepeatingCharacters = $false } if($ExcludeCharacters) { $NewProfileObject.ExcludeCharacters = $ExcludeCharacters } else { $NewProfileObject.ExcludeCharacters = '' } if($Length) { $NewProfileObject.Length = $Length } else { $NewProfileObject.Length = '20' } $PassProfile.CharSet.Add($NewProfileObject.CharacterSet) $PassProfile.ExcludeLookAlike = $NewProfileObject.ExlcudeLookAlike $PassProfile.NoRepeatingCharacters = $NewProfileObject.NoRepeatingCharacters $PassProfile.ExcludeCharacters = $NewProfileObject.ExcludeCharacters $PassProfile.Length = $NewProfileObject.Length } } elseif($PSCmdlet.ParameterSetName -eq 'Profile') { $PasswordProfileObject = Get-KPPasswordProfile -PasswordProfileName $PasswordProfileName if(-not $PasswordProfileObject) { Write-Error -Message ('No KPPasswordProfile could be found with the specified Name: ' + $PasswordProfileName) -TargetObject $PasswordProfileName -Category ObjectNotFound -ErrorAction Stop } $PassProfile.CharSet.Add($PasswordProfileObject.CharacterSet) $PassProfile.ExcludeLookAlike = if($PasswordProfileObject.ExlcudeLookAlike -eq 'True'){$true}else{$false} $PassProfile.NoRepeatingCharacters = if($PasswordProfileObject.NoRepeatingCharacters -eq 'True'){$true}else{$false} $PassProfile.ExcludeCharacters = $PasswordProfileObject.ExcludeCharacters $PassProfile.Length = $PasswordProfileObject.Length } ## Create Pass Generator Profile Pool. $GenPassPool = New-Object KeePassLib.Cryptography.PasswordGenerator.CustomPwGeneratorPool ## Create Out Parameter aka [rel] param. [KeePassLib.Security.ProtectedString]$PSOut = New-Object KeePassLib.Security.ProtectedString ## Generate Password. $ResultMessage = [KeePassLib.Cryptography.PasswordGenerator.PwGenerator]::Generate([ref] $PSOut, $PassProfile, $null, $GenPassPool) ## Check if Password Generation was successful if($ResultMessage -ne 'Success') { Write-Warning -Message '[PROCESS] Failure while attempting to generate a password with the specified settings or profile.' Write-Warning -Message ('[PROCESS] Password Generation Failed with the Result Text: {0}.' -f $ResultMessage) if($ResultMessage -eq 'TooFewCharacters') { Write-Warning -Message ('[PROCESS] Result Text {0}, typically means that you specified a length that is longer than the possible generated outcome.' -f $ResultMessage) $ExcludeCharacterCount = if($PassProfile.ExcludeCharacters){($PassProfile.ExcludeCharacters -split ',').Count}else{0} if($PassProfile.NoRepeatingCharacters -and $PassProfile.Length -gt ($PassProfile.CharSet.Size - $ExcludeCharacterCount)) { Write-Warning -Message "[PROCESS] Checked for the invalid specification. `n`tSpecified Length: $($PassProfile.Length). `n`tCharacterSet Count: $($PassProfile.CharSet.Size). `n`tNo Repeating Characters is set to: $($PassProfile.NoRepeatingCharacters). `n`tExclude Character Count: $ExcludeCharacterCount." Write-Warning -Message '[PROCESS] Specify More characters, shorten the length, remove the no repeating characters option, or removed excluded characters.' } } Throw 'Unabled to generate a password with the specified options.' } else { if($SaveAs) { $NewProfileObject.ProfileName = $SaveAs New-KPPasswordProfile -KeePassPasswordObject $NewProfileObject } } try { $PSOut } catch { Write-Warning -Message '[PROCESS] An exception occured while trying to convert the KeePassLib.Securtiy.ProtectedString to a SecureString.' Write-Warning -Message ('[PROCESS] Exception Message: {0}' -f $_.Exception.Message) Throw $_ } } end { if($PSOut){Remove-Variable -Name PSOUT} } } function Remove-KeePassDatabaseConfiguration { <# .SYNOPSIS Function to remove a KeePass Database Configuration Profile. .DESCRIPTION This function allows a specified database configuration profile to be removed from the KeePassConfiguration.xml file. .PARAMETER DatabaseProfileName Specify the name of the profile to be deleted. .EXAMPLE PS> Remove-KeePassDatabaseConfiguration -DatabaseProfileName 'Personal' This Example will remove the database configuration profile 'Personal' from the KeePassConfiguration.xml file. .INPUTS Strings .OUTPUTS $null #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, Mandatory, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('Name')] [string] $DatabaseProfileName ) begin { } process { if($PSCmdlet.ShouldProcess($DatabaseProfileName)) { try { [Xml] $XML = New-Object -TypeName System.Xml.XmlDocument $XML.Load($SCRIPT:KeePassConfigurationFile) $XML.Settings.DatabaseProfiles.Profile | Where-Object { $_.Name -eq $DatabaseProfileName } | ForEach-Object { $xml.Settings.DatabaseProfiles.RemoveChild($_) } | Out-Null $XML.Save($SCRIPT:KeePassConfigurationFile) } catch { Write-Warning -Message ('[PROCESS] An exception occured while attempting to remove a KeePass Database Configuration Profile ({0}).' -f $DatabaseProfileName) Write-Warning -Message ('[PROCESS] {0}' -f $_.Exception.Message) Throw $_ } } } } function Remove-KeePassEntry { <# .SYNOPSIS Function to remove a KeePass Database Entry. .DESCRIPTION This function removed a KeePass Database Entry. .PARAMETER KeePassEntry The KeePass Entry to be removed. Use the Get-KeePassEntry function to get this object. .PARAMETER DatabaseProfileName *This Parameter is required in order to access your KeePass database. .PARAMETER NoRecycle Specify this option to Permanently delete the entry and not recycle it. .PARAMETER Force Specify this option to forcefully delete the entry. .PARAMETER MasterKey Specify a SecureString MasterKey if necessary to authenticat a keepass databse. If not provided and the database requires one you will be prompted for it. This parameter was created with scripting in mind. .EXAMPLE PS> Remove-KeePassEntry -KeePassEntry $KeePassEntryObject This example removed the specified kee pass entry. #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline)] [ValidateNotNullOrEmpty()] [PSObject] $KeePassEntry, [Parameter(Position = 1)] [Switch] $NoRecycle, [Parameter(Position = 2)] [Switch] $Force, [Parameter(Position = 3, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [string] $DatabaseProfileName, [Parameter(Position = 4)] [ValidateNotNullOrEmpty()] [PSobject] $MasterKey ) begin { } process { $KeePassConnectionObject = New-KPConnection -DatabaseProfileName $DatabaseProfileName -MasterKey $MasterKey Remove-Variable -Name MasterKey -ea 0 $KPEntry = Get-KPEntry -KeePassConnection $KeePassConnectionObject -KeePassUuid $KeePassEntry.Uuid if(-not $KPEntry) { Write-Warning -Message '[PROCESS] The Specified KeePass Entry does not exist or cannot be found.' Throw 'The Specified KeePass Entry does not exist or cannot be found.' } $EntryDisplayName = '{0}/{1}' -f $KPEntry.ParentGroup.GetFullPath('/', $true), $KPEntry.Strings.ReadSafe('Title') if($Force -or $PSCmdlet.ShouldProcess($EntryDisplayName)) { [hashtable] $params = @{ 'KeePassConnection' = $KeePassConnectionObject; 'KeePassEntry' = $KPEntry; 'Confirm' = $false; 'Force' = $Force; } if($NoRecycle){ $params.NoRecycle = $NoRecycle } Remove-KPEntry @params } } end { Remove-KPConnection -KeePassConnection $KeePassConnectionObject } } function Remove-KeePassGroup { <# .SYNOPSIS Function to remove a KeePass Database Group. .DESCRIPTION This function removed a KeePass Database Group. .PARAMETER KeePassGroup The KeePass Group to be removed. Use the Get-KeePassEntry function to get this object. .PARAMETER DatabaseProfileName *This Parameter is required in order to access your KeePass database. .PARAMETER NoRecycle Specify this option to Permanently delete the Group and not recycle it. .PARAMETER Force Specify this option to forcefully delete the Group. .PARAMETER MasterKey Specify a SecureString MasterKey if necessary to authenticat a keepass databse. If not provided and the database requires one you will be prompted for it. This parameter was created with scripting in mind. .EXAMPLE PS> Remove-KeePassGroup -KeePassGroup $KeePassGroupObject This example removed the specified keepass Group. #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline)] [ValidateNotNullOrEmpty()] [PSObject] $KeePassGroup, [Parameter(Position = 1)] [Switch] $NoRecycle, [Parameter(Position = 2)] [Switch] $Force, [Parameter(Position = 3, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [string] $DatabaseProfileName, [Parameter(Position = 4)] [ValidateNotNullOrEmpty()] [PSobject] $MasterKey ) begin { } process { $KeePassConnectionObject = New-KPConnection -DatabaseProfileName $DatabaseProfileName -MasterKey $MasterKey Remove-Variable -Name MasterKey -ea 0 $KeePassGroupObject = Get-KPGroup -KeePassConnection $KeePassConnectionObject -FullPath $KeePassGroup.FullPath -Stop | Where-Object { $_.CreationTime -eq $KeePassGroup.CreationTime} if($KeePassGroupObject.Count -gt 1) { Write-Warning -Message '[PROCESS] Found more than one group with the same path, name and creation time. Stoping Removal.' Write-Warning -Message ('[PROCESS] Found: ({0}) number of matching groups.' -f $KeePassGroupObject.Count) Throw 'Found more than one group with the same path, name and creation time. Stoping Removal.' } if($Force -or $PSCmdlet.ShouldProcess($KeePassGroup.FullPath)) { if(-not $NoRecycle) { Remove-KPGroup -KeePassConnection $KeePassConnectionObject -KeePassGroup $KeePassGroupObject -Confirm:$false -Force } else { if($Force -or $PSCmdlet.ShouldContinue('Recycle Bin Does Not Exist or the -NoRecycle Option Has been Specified.', "Remove this Group permanetly: $KeePassGroup.FullPath?")) { Remove-KPGroup -KeePassConnection $KeePassConnectionObject -KeePassGroup $KeePassGroupObject -NoRecycle:$NoRecycle -Confirm:$false -Force } } } } end { Remove-KPConnection -KeePassConnection $KeePassConnectionObject } } function Update-KeePassDatabaseConfiguration { <# .SYNOPSIS Function to Update a KeePass Database Configuration Profile in the KeePassConfiguration.xml .DESCRIPTION The Profile Created will be accessible from the core functions Get,Update,New,Remove KeePassEntry and ect. The Profile stores database configuration for opening and authenticating to a keepass database. Using the configuration allows for speedier authentication and less complex commands. .PARAMETER DatabaseProfileName Specify the Name of the new Database Configuration Profile. .PARAMETER DatabasePath Specify the Path to the database (.kdbx) file. .PARAMETER KeyPath Specify the Path to the database (.key) key file if there is one. .PARAMETER UseNetworkAccount Specify this flag if the database uses NetworkAccount Authentication. .PARAMETER UseMasterKey Specify this flag if the database uses a Master Key Password for Authentication. .PARAMETER PassThru Specify to return the new database configuration profile object. .EXAMPLE PS> New-KeePassDatabaseConfiguration -DatabaseProfileName 'Personal' -DatabasePath 'c:\users\username\documents\personal.kdbx' -KeyPath 'c:\users\username\documents\personal.key' -UseNetworkAccount This Example adds a Database Configuration Profile to the KeePassConfiguration.xml file with the Name Personal specifying the database file and authentication components; Key File and Uses NetworkAccount. .EXAMPLE PS> New-KeePassDatabaseConfiguration -DatabaseProfileName 'Personal' -DatabasePath 'c:\users\username\documents\personal.kdbx' -UseNetworkAccount This Example adds a Database Configuration Profile to the KeePassConfiguration.xml file with the Name Personal specifying the database file and authentication components; Uses NetworkAccount. .NOTES 1. Currently all authentication combinations are supported except keyfile, masterkey password, and network authentication together. .INPUTS Strings .OUTPUTS $null #> [CmdletBinding(DefaultParameterSetName = '_none')] param ( [Parameter(Position = 0, Mandatory)] [ValidateNotNullOrEmpty()] [String] $DatabaseProfileName, [Parameter(Position = 1)] [ValidateNotNullOrEmpty()] [String] $NewDatabaseProfileName = $DatabaseProfileName, [Parameter(Position = 2, ParameterSetName = 'Key')] [Parameter(Position = 2, ParameterSetName = 'Master')] [Parameter(Position = 2, ParameterSetName = 'Network')] [Parameter(Position = 2, ParameterSetName = 'KeyAndMaster')] [ValidateNotNullOrEmpty()] [ValidateScript({Test-Path $_})] [String] $DatabasePath, [Parameter(Position = 2, ParameterSetName = 'Key')] [Parameter(Position = 2, ParameterSetName = 'KeyAndMaster')] [ValidateNotNullOrEmpty()] [ValidateScript({Test-Path $_})] [String] $KeyPath, [Parameter(Position = 4, ParameterSetName = 'Key')] [Parameter(Position = 4, ParameterSetName = 'Master')] [Parameter(Position = 4, ParameterSetName = 'Network')] [Switch] $UseNetworkAccount, [Parameter(Position = 5, Mandatory, ParameterSetName = 'Master')] [Parameter(Position = 5, Mandatory, ParameterSetName = 'KeyAndMaster')] [Switch] $UseMasterKey, [Parameter(Position = 6)] [Switch] $Default, [Parameter(Position = 7)] [Switch] $PassThru ) begin { if($PSCmdlet.ParameterSetName -eq 'Network' -and -not $UseNetworkAccount) { Write-Warning -Message '[BEGIN] Please Specify a valid Credential Combination.' Write-Warning -Message '[BEGIN] You can not have only a database file with no authentication options.' throw 'Please Specify a valid Credential Combination.' } } process { # throw 'Update-KeePassDatabaseConfiguration not yet implemented.' if (-not (Test-Path -Path $SCRIPT:KeePassConfigurationFile)) { Write-Verbose -Message '[PROCESS] A KeePass Configuration File does not exist. One will be generated now.' New-KPConfigurationFile } else { $CheckIfProfileExists = Get-KeePassDatabaseConfiguration -DatabaseProfileName $DatabaseProfileName } if(-not $CheckIfProfileExists) { Write-Warning -Message ('[PROCESS] A KeePass Database Configuration Profile does not exists with the specified name: {0}.' -f $DatabaseProfileName) throw '[PROCESS] A KeePass Database Configuration Profile does not exists with the specified name: {0}.' -f $DatabaseProfileName } else { if($Default) { $defaultProfile = Get-KeePassDatabaseConfiguration -Default if($defaultProfile -and $defaultProfile.Name -ine $DatabaseProfileName) { throw ('{0} profile is already set to the default, if you would like to overwrite it as the default please use the Update-KeePassDatabaseConfiguration function and remove the default flag.' -f $defaultProfile.Name) } } try { [Xml] $XML = New-Object -TypeName System.Xml.XmlDocument $XML.Load($SCRIPT:KeePassConfigurationFile) $OldProfile = $XML.SelectNodes('/Settings/DatabaseProfiles/Profile') | Where-Object { $_.Name -eq $DatabaseProfileName } if(-not $DatabasePath){ $_DatabasePath = $OldProfile.DatabasePath } if(Test-Bound -ParameterName 'UseMasterKey' -Not){ $_UseMasterKey = [bool]::Parse($OldProfile.UseMasterKey) } if(-not $KeyPath){ $_KeyPath = $OldProfile.KeyPath} if(Test-Bound -ParameterName 'UseNetworkAccount' -Not){ $_UseNetworkAccount = [bool]::Parse($OldProfile.UseNetworkAccount) } if($PSCmdlet.ParameterSetName -eq '_none'){ $_AuthenticationType = $OldProfile.AuthenticationType } else{ $_AuthenticationType = $PSCmdlet.ParameterSetName} ## Create New Profile Element with Name of the new profile $DatabaseProfile = $XML.CreateElement('Profile') $DatabaseProfileAtribute = $XML.CreateAttribute('Name') $DatabaseProfileAtribute.Value = $NewDatabaseProfileName $DatabaseProfile.Attributes.Append($DatabaseProfileAtribute) | Out-Null ## Build and Add Element Nodes $DatabasePathNode = $XML.CreateNode('element', 'DatabasePath', '') $DatabasePathNode.InnerText = $_DatabasePath $DatabaseProfile.AppendChild($DatabasePathNode) | Out-Null $KeyPathNode = $XML.CreateNode('element', 'KeyPath', '') $KeyPathNode.InnerText = $_KeyPath $DatabaseProfile.AppendChild($KeyPathNode) | Out-Null $UseNetworkAccountNode = $XML.CreateNode('element', 'UseNetworkAccount', '') $UseNetworkAccountNode.InnerText = $_UseNetworkAccount $DatabaseProfile.AppendChild($UseNetworkAccountNode) | Out-Null $UseMasterKeyNode = $XML.CreateNode('element', 'UseMasterKey', '') $UseMasterKeyNode.InnerText = $_UseMasterKey $DatabaseProfile.AppendChild($UseMasterKeyNode) | Out-Null $AuthenticationTypeNode = $XML.CreateNode('element', 'AuthenticationType', '') $AuthenticationTypeNode.InnerText = $_AuthenticationType $DatabaseProfile.AppendChild($AuthenticationTypeNode) | Out-Null $DefaultNode = $XML.CreateNode('element', 'Default', '') $DefaultNode.InnerText = $Default $DatabaseProfile.AppendChild($DefaultNode) | Out-Null $XML.SelectSingleNode('/Settings/DatabaseProfiles').ReplaceChild($DatabaseProfile, $OldProfile) | Out-Null $XML.Save($SCRIPT:KeePassConfigurationFile) $Script:KeePassProfileNames = (Get-KeePassDatabaseConfiguration).Name if($PassThru) { Get-KeePassDatabaseConfiguration -DatabaseProfileName $NewDatabaseProfileName } } catch { Write-Warning -Message ('[PROCESS] An Exception Occured while trying to add a new KeePass database configuration ({0}) to the configuration file.' -f $NewDatabaseProfileName) Write-Warning -Message ('[PROCESS] {0}' -f $_.Exception.Message) Throw $_ } } } } function Update-KeePassEntry { <# .SYNOPSIS Function to update a KeePass Database Entry. .DESCRIPTION This function updates a KeePass Database Entry with basic properites available for specification. .PARAMETER KeePassEntry The KeePass Entry to be updated. Use the Get-KeePassEntry function to get this object. .PARAMETER KeePassEntryGroupPath Specify this parameter if you wish to only return entries form a specific folder path. Notes: * Path Separator is the foward slash character '/' .PARAMETER DatabaseProfileName *This Parameter is required in order to access your KeePass database. .PARAMETER Title Specify the Title of the new KeePass Database Entry. .PARAMETER UserName Specify the UserName of the new KeePass Database Entry. .PARAMETER KeePassPassword *Specify the KeePassPassword of the new KeePass Database Entry. *Notes: *This Must be of the type SecureString or KeePassLib.Security.ProtectedString .PARAMETER Notes Specify the Notes of the new KeePass Database Entry. .PARAMETER URL Specify the URL of the new KeePass Database Entry. .PARAMETER PassThru Specify to return the modified object. .PARAMETER Force Specify to Update the specified entry without confirmation. .PARAMETER MasterKey Specify a SecureString MasterKey if necessary to authenticat a keepass databse. If not provided and the database requires one you will be prompted for it. This parameter was created with scripting in mind. .PARAMETER IconName Specify the Name of the Icon for the Entry to display in the KeePass UI. .PARAMETER Expires Specify if you want the KeePass Object to Expire, default is to not expire. .PARAMETER ExpiryTime Datetime expiration Time value. .EXAMPLE PS> Update-KeePassEntry -KeePassEntry $KeePassEntryObject -DatabaseProfileName TEST -KeePassEntryGroupPath 'General/TestAccounts' -Title 'Test Title' -UserName 'Domain\svcAccount' -KeePassPassword $(New-KeePassPassword -upper -lower -digits -length 20) This example updates a keepass database entry in the General/TestAccounts database group, with the specified Title and UserName. Also the function New-KeePassPassword is used to generated a random password with the specified options. .EXAMPLE PS> Update-KeePassEntry -KeePassEntry $KeePassEntryObject -DatabaseProfileName TEST -KeePassEntryGroupPath 'General/TestAccounts' -Title 'Test Title' -UserName 'Domain\svcAccount' -KeePassPassword $(New-KeePassPassword -PasswordProfileName 'Default' ) This example updates a keepass database entry in the General/TestAccounts database group, with the specified Title and UserName. Also the function New-KeePassPassword with a password profile specifed to create a new password genereated from options saved to a profile. .EXAMPLE PS> Update-KeePassEntry -KeePassEntry $KeePassEntryObject -DatabaseProfileName TEST -Title 'Test Title' -UserName 'Domain\svcAccount' -KeePassPassword $(ConvertTo-SecureString -String 'apassword' -AsPlainText -Force) This example updates a keepass database entry with the specified Title, UserName and manually specified password converted to a securestring. .INPUTS String SecureString .OUTPUTS $null #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline)] [ValidateNotNullOrEmpty()] [PSObject] $KeePassEntry, [Parameter(Position = 1, Mandatory, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('FullPath')] [String] $KeePassEntryGroupPath, [Parameter(Position = 2)] [ValidateNotNullOrEmpty()] [String] $Title, [Parameter(Position = 3)] [ValidateNotNullOrEmpty()] [String] $UserName, [Parameter(Position = 4)] [ValidateNotNullOrEmpty()] [ValidateScript({$_.GetType().Name -eq 'ProtectedString' -or $_.GetType().Name -eq 'SecureString'})] [PSObject] $KeePassPassword, [Parameter(Position = 5)] [ValidateNotNullOrEmpty()] [String] $Notes, [Parameter(Position = 6)] [ValidateNotNullOrEmpty()] [String] $URL, [Parameter(Position = 7)] [ValidateNotNullOrEmpty()] [string] $IconName, [Parameter(Position = 8)] [switch] $Expires, [Parameter(Position = 9)] [DateTime] $ExpiryTime, [Parameter(Position = 10, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [string] $DatabaseProfileName, [Parameter(Position = 11)] [ValidateNotNullOrEmpty()] [PSobject] $MasterKey, [Parameter(Position = 12)] [Switch] $PassThru, [Parameter(Position = 13)] [Switch] $Force ) begin { } process { $KeePassConnectionObject = New-KPConnection -DatabaseProfileName $DatabaseProfileName -MasterKey $MasterKey Remove-Variable -Name MasterKey -ea 0 $KPEntry = Get-KPEntry -KeePassConnection $KeePassConnectionObject -KeePassUuid $KeePassEntry.Uuid if(-not $KPEntry) { Write-Warning -Message '[PROCESS] The Specified KeePass Entry does not exist or cannot be found.' Throw 'The Specified KeePass Entry does not exist or cannot be found.' } if($Force -or $PSCmdlet.ShouldProcess("Title: $($KPEntry.Strings.ReadSafe('Title')), `n`tUserName: $($KPEntry.Strings.ReadSafe('UserName')), `n`tGroupPath: $($KPEntry.ParentGroup.GetFullPath('/', $true)).")) { $KeePassGroup = Get-KpGroup -KeePassConnection $KeePassConnectionObject -FullPath $KeePassEntryGroupPath -Stop $setKPEntrySplat = @{ URL = $URL KeePassEntry = $KPEntry UserName = $UserName Notes = $Notes KeePassPassword = $KeePassPassword KeePassGroup = $KeePassGroup PassThru = $PassThru Force = $true Title = $Title KeePassConnection = $KeePassConnectionObject } if($IconName){ $setKPEntrySplat.IconName = $IconName } if(Test-Bound -ParameterName 'Expires'){ $setKPEntrySplat.Expires = $Expires } if($ExpiryTime){ $setKPEntrySplat.ExpiryTime = $ExpiryTime} Set-KPEntry @setKPEntrySplat | ConvertTo-KPPSObject -DatabaseProfileName $DatabaseProfileName } } end { Remove-KPConnection -KeePassConnection $KeePassConnectionObject } } function Update-KeePassGroup { <# .SYNOPSIS Function to update a KeePass Database Group. .DESCRIPTION This function updates a KeePass Database Group. .PARAMETER KeePassGroup The KeePass Group to be updated. Use the Get-KeePassGroup function to get this object. .PARAMETER KeePassParentGroupPath Specify this parameter if you wish move the specified group to a different parent group. Notes: * Path Separator is the foward slash character '/' .PARAMETER DatabaseProfileName *This Parameter is required in order to access your KeePass database. .PARAMETER GroupName Specify the GroupName to change the specified group to. .PARAMETER PassThru Specify to return the updated keepass group object. .PARAMETER Force Specify to Update the specified group without confirmation. .PARAMETER MasterKey Specify a SecureString MasterKey if necessary to authenticat a keepass databse. If not provided and the database requires one you will be prompted for it. This parameter was created with scripting in mind. .PARAMETER IconName Specify the Name of the Icon for the Group to display in the KeePass UI. .PARAMETER Notes Specify group notes .PARAMETER Expires Specify if you want the KeePass Object to Expire, default is to not expire. .PARAMETER ExpiryTime Datetime expiration Time value. .EXAMPLE PS> Update-KeePassGroup -DatabaseProfileName TEST -KeePassGroup $KeePassGroupObject -KeePassParentGroupPath 'General/TestAccounts' This Example moves the specified KeePassGroup to a New parent group path. .EXAMPLE PS> Get-KeePassGroup -DatabaseProfileName 'TEST' -KeePassGroupPath 'General/DevAccounts/testgroup' | Update-KeePassGroup -DatabaseProfileName TEST -KeePassParentGroupPath 'General/TestAccounts' This Example moves group specified via the pipeline to a New parent group path. .EXAMPLE PS> Get-KeePassGroup -DatabaseProfileName 'TEST' -KeePassGroupPath 'General/DevAccounts/testgroup' | Update-KeePassGroup -DatabaseProfileName TEST -GroupName 'DevGroup' This Example renames the group specified via the pipeline to 'DevGroup' .INPUTS String SecureString .OUTPUTS $null #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline)] [ValidateNotNullOrEmpty()] [PSObject] $KeePassGroup, [Parameter(Position = 0, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('FullPath')] [String] $KeePassParentGroupPath, [Parameter(Position = 1)] [ValidateNotNullOrEmpty()] [String] $GroupName, [Parameter(Position = 2)] [ValidateNotNullOrEmpty()] [string] $IconName, [Parameter(Position = 5)] [ValidateNotNullOrEmpty()] [String] $Notes, [Parameter(Position = 3)] [switch] $Expires, [Parameter(Position = 4)] [DateTime] $ExpiryTime, [Parameter(Position = 5, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [string] $DatabaseProfileName, [Parameter(Position = 6)] [ValidateNotNullOrEmpty()] [PSobject] $MasterKey, [Parameter(Position = 7)] [Switch] $PassThru, [Parameter(Position = 8)] [Switch] $Force ) begin { } process { $KeePassConnectionObject = New-KPConnection -DatabaseProfileName $DatabaseProfileName -MasterKey $MasterKey Remove-Variable -Name MasterKey -ea 0 if($KeePassParentGroupPath -and $KeePassParentGroupPath -ne $KeePassGroup.FullPath) { $KeePassParentGroup = Get-KpGroup -KeePassConnection $KeePassConnectionObject -FullPath $KeePassParentGroupPath -Stop } if($Force -or $PSCmdlet.ShouldProcess($KeePassGroup.FullPath)) { $KeePassGroupObject = Get-KPGroup -KeePassConnection $KeePassConnectionObject -FullPath $KeePassGroup.FullPath | Where-Object { $_.CreationTime -eq $KeePassGroup.CreationTime } if($KeePassGroupObject.Count -gt 1) { Write-Warning -Message '[PROCESS] Found more than one group with the same path, name and creation time. Stoping Update.' Write-Warning -Message ('[PROCESS] Found: ({0}) number of matching groups' -f $KeePassGroupObject.Count) Throw 'Found more than one group with the same path, name and creation time.' } $setKPGroupSplat = @{ KeePassConnection = $KeePassConnectionObject KeePassGroup = $KeePassGroupObject PassThru = $PassThru Force = $true GroupName = $GroupName Confirm = $false Notes = $Notes } if($IconName){ $setKPGroupSplat.IconName = $IconName } if($KeePassParentGroup){ $setKPGroupSplat.KeePassParentGroup = $KeePassParentGroup } if(Test-Bound -ParameterName 'Expires'){ $setKPGroupSplat.Expires = $Expires } if($ExpiryTime){ $setKPGroupSplat.ExpiryTime = $ExpiryTime } Set-KPGroup @setKPGroupSplat | ConvertTo-KpPsObject -DatabaseProfileName $DatabaseProfileName } } end { Remove-KPConnection -KeePassConnection $KeePassConnectionObject } } function Add-KPEntry { <# .SYNOPSIS This Function will add a new entry to a KeePass Database Group. .DESCRIPTION This Function will add a new entry to a KeePass Database Group. Currently This function supportes the basic fields for creating a new KeePass Entry. .PARAMETER KeePassConnection This is the Open KeePass Database Connection See Get-KeePassConnection to Create the conneciton Object. .PARAMETER KeePassGroup This is the KeePass GroupObject to add the new Entry to. .PARAMETER Title This is the Title of the New KeePass Entry. .PARAMETER UserName This is the UserName of the New KeePass Entry. .PARAMETER KeePassPassword This is the Password of the New KeePass Entry. .PARAMETER Notes This is the Notes of the New KeePass Entry. .PARAMETER URL This is the URL of the New KeePass Entry. .PARAMETER PassThru Returns the New KeePass Entry after creation. .PARAMETER IconName Specify the Name of the Icon for the Entry to display in the KeePass UI. .PARAMETER Expires Specify if you want the KeePass Object to Expire, default is to not expire. .PARAMETER ExpiryTime Datetime expiration Time value. .NOTES This Cmdlet will autosave on exit #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory)] [ValidateNotNullOrEmpty()] [KeePassLib.PwDatabase] $KeePassConnection, [Parameter(Position = 1, Mandatory)] [ValidateNotNullOrEmpty()] [KeePassLib.PwGroup] $KeePassGroup, [Parameter(Position = 2)] [String] $Title, [Parameter(Position = 3)] [String] $UserName, [Parameter(Position = 4)] [PSObject] $KeePassPassword, [Parameter(Position = 5)] [String] $Notes, [Parameter(Position = 6)] [String] $URL, [Parameter(Position = 7)] [KeePassLib.PwIcon] $IconName, [Parameter(Position = 8)] [bool] $Expires, [Parameter(Position = 9)] [DateTime] $ExpiryTime, [Parameter(Position = 10)] [Switch] $PassThru ) begin { try { [KeePassLib.PwEntry] $KeePassEntry = New-Object KeePassLib.PwEntry($true, $true) -ea Stop } catch { Write-Warning -Message '[BEGIN] An error occured while creating a new KeePassLib.PwEntry Object.' Write-Error -ErrorRecord $_ -ea Stop } } process { if((Test-KPPasswordValue $KeePassPassword) -and (Test-KPConnection $KeePassConnection)) { if($Title) { [KeePassLib.Security.ProtectedString] $SecureTitle = New-Object KeePassLib.Security.ProtectedString($KeePassConnection.MemoryProtection.ProtectTitle, $Title) $KeePassEntry.Strings.Set('Title', $SecureTitle) } if($UserName) { [KeePassLib.Security.ProtectedString] $SecureUser = New-Object KeePassLib.Security.ProtectedString($KeePassConnection.MemoryProtection.ProtectUserName, $UserName) $KeePassEntry.Strings.Set('UserName', $SecureUser) } if($KeePassPassword) { if($KeePassPassword.GetType().Name -eq 'SecureString') { [KeePassLib.Security.ProtectedString] $KeePassSecurePasswordString = New-Object KeePassLib.Security.ProtectedString $KeePassSecurePasswordString = $KeePassSecurePasswordString.Insert(0, [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($KeePassPassword))).WithProtection($true) } elseif($KeePassPassword.GetType().Name -eq 'ProtectedString') { $KeePassSecurePasswordString = $KeePassPassword } $KeePassEntry.Strings.Set('Password', $KeePassSecurePasswordString) } else { ## get password based on default pattern $KeePassSecurePasswordString = New-KeePassPassword $KeePassEntry.Strings.Set('Password', $KeePassSecurePasswordString) } if($Notes) { [KeePassLib.Security.ProtectedString] $SecureNotes = New-Object KeePassLib.Security.ProtectedString($KeePassConnection.MemoryProtection.ProtectNotes, $Notes) $KeePassEntry.Strings.Set('Notes', $SecureNotes) } if($URL) { [KeePassLib.Security.ProtectedString] $SecureURL = New-Object KeePassLib.Security.ProtectedString($KeePassConnection.MemoryProtection.ProtectUrl, $URL) $KeePassEntry.Strings.Set('URL', $SecureURL) } if($IconName -and $IconName -ne $KeePassEntry.IconId) { $KeePassEntry.IconId = $IconName } if(Test-Bound -ParameterName 'Expires') { $KeePassEntry.Expires = $Expires } if($ExpiryTime) { $KeePassEntry.ExpiryTime = $ExpiryTime.ToUniversalTime() } $KeePassGroup.AddEntry($KeePassEntry, $true) $KeePassConnection.Save($null) if($PassThru) { $KeePassEntry } } } } function Add-KPGroup { <# .SYNOPSIS Creates a New KeePass Folder Group. .DESCRIPTION Creates a New KeePass Folder Group. .EXAMPLE PS> Add-KPGroup -KeePassConnection $Conn -GroupName 'NewGroupName' -KeePassParentGroup $KpGroup This Example Create a New Group with the specified name in the specified KeePassParentGroup. .PARAMETER KeePassConnection This is the Open KeePass Database Connection See Get-KeePassConnection to Create the conneciton Object. .PARAMETER GroupName Specify the name of the new group(s). .PARAMETER KeePassParentGroup Sepcify the KeePassParentGroup(s) for the new Group(s). .PARAMETER IconName Specify the Name of the Icon for the Group to display in the KeePass UI. .PARAMETER Notes Specify group notes .PARAMETER PassThru Specify to return the new keepass group object. .PARAMETER Expires Specify if you want the KeePass Object to Expire, default is to not expire. .PARAMETER ExpiryTime Datetime expiration Time value. .NOTES This Cmdlet Does AutoSave on exit. #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNull()] [KeePassLib.PwDatabase] $KeePassConnection, [Parameter(Position = 1, Mandatory)] [ValidateNotNullorEmpty()] [String] $GroupName, [Parameter(Position = 2, Mandatory)] [ValidateNotNullOrEmpty()] [KeePassLib.PwGroup] $KeePassParentGroup, [Parameter(Position = 3)] [KeePassLib.PwIcon] $IconName, [Parameter(Position = 4)] [String] $Notes, [Parameter(Position = 5)] [bool] $Expires, [Parameter(Position = 6)] [DateTime] $ExpiryTime, [Parameter(Position = 7)] [Switch] $PassThru ) begin { try { [KeePassLib.PwGroup] $KeePassGroup = New-Object KeePassLib.PwGroup -ea Stop } catch { Write-Warning -Message '[BEGIN] An error occured while creating a new KeePassLib.PwGroup Object.' Write-Error -ErrorRecord $_ -ea Stop } } process { if(Test-KPConnection $KeePassConnection) { $KeePassGroup.Name = $GroupName if($IconName -and $IconName -ne $KeePassGroup.IconId) { $KeePassGroup.IconId = $IconName } if($Notes) { $KeePassGroup.Notes = $Notes } if(Test-Bound -ParameterName 'Expires') { $KeePassGroup.Expires = $Expires } if($ExpiryTime) { $KeePassGroup.ExpiryTime = $ExpiryTime.ToUniversalTime() } $KeePassParentGroup.AddGroup($KeePassGroup, $true) $KeePassConnection.Save($null) if($PassThru) { $KeePassGroup } } } } function ConvertFrom-KPProtectedString { <# .SYNOPSIS This Function will Convert a KeePass ProtectedString to Plain Text. .DESCRIPTION This Function will Convert a KeePassLib.Security.ProtectedString to Plain Text. This Would Primarily be used for Reading Title,UserName,Password,Notes, and URL ProtectedString Values. .EXAMPLE PS>Get-KeePassPassword -UpperCase -LowerCase -Digits -SpecialCharacters -Length 21 | ConvertFrom-KeePassProtectedString This Example will created a password using the specified options and convert the resulting password to a string. .PARAMETER KeePassProtectedString This is the KeePassLib.Security.ProtectedString to be converted to plain text #> [CmdletBinding()] [OutputType([String])] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNull()] [KeePassLib.Security.ProtectedString] $KeePassProtectedString ) process { $KeePassProtectedString.ReadSafe() } } function Get-KPEntry { <# .SYNOPSIS This function will lookup and Return KeePass one or more KeePass Entries. .DESCRIPTION This function will lookup Return KeePass Entry(ies). It supports basic lookup filtering. .EXAMPLE PS> Get-KPEntryBase -KeePassConnection $DB -UserName "MyUser" This Example will return all entries that have the UserName "MyUser" .EXAMPLE PS> Get-KPEntry -KeePassConnection $DB -KeePassGroup $KpGroup This Example will return all entries that are in the specified group. .EXAMPLE PS> Get-KPEntry -KeePassConnection $DB -UserName "AUserName" This Example will return all entries have the UserName "AUserName" .PARAMETER KeePassConnection This is the Open KeePass Database Connection See Get-KeePassConnection to Create the conneciton Object. .PARAMETER KeePassGroup This is the KeePass Group Object in which to search for entries. .PARAMETER Title This is a Title of one or more KeePass Entries. .PARAMETER UserName This is the UserName of one or more KeePass Entries. .PARAMETER KeePassUuid Specify the KeePass Entry Uuid for reverse lookup. #> [CmdletBinding(DefaultParameterSetName = 'None')] [OutputType('KeePassLib.PwEntry')] param ( [Parameter(Position = 0, Mandatory, ParameterSetName = 'None')] [Parameter(Position = 0, Mandatory, ParameterSetName = 'UUID')] [Parameter(Position = 0, Mandatory, ParameterSetName = 'Group')] [Parameter(Position = 0, Mandatory, ParameterSetName = 'Title')] [Parameter(Position = 0, Mandatory, ParameterSetName = 'UserName')] [Parameter(Position = 0, Mandatory, ParameterSetName = 'Password')] [ValidateNotNullOrEmpty()] [KeePassLib.PwDatabase] $KeePassConnection, [Parameter(Position = 1, Mandatory, ParameterSetName = 'Group')] [ValidateNotNullOrEmpty()] [KeePassLib.PwGroup[]] $KeePassGroup, [Parameter(Position = 1, Mandatory, ParameterSetName = 'UUID', ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('Uuid')] [KeePassLib.PwUuid] $KeePassUuid, [Parameter(Position = 2, ParameterSetName = 'Group')] [Parameter(Position = 1, Mandatory, ParameterSetName = 'Title')] [ValidateNotNullOrEmpty()] [String] $Title, [Parameter(Position = 3, ParameterSetName = 'Group')] [Parameter(Position = 2, ParameterSetName = 'Title')] [Parameter(Position = 1, Mandatory, ParameterSetName = 'UserName')] [ValidateNotNullOrEmpty()] [String] $UserName ) process { if(Test-KPConnection $KeePassConnection) { $KeePassItems = $KeePassConnection.RootGroup.GetEntries($true) if($PSCmdlet.ParameterSetName -eq 'UUID') { $KeePassItems | Where-Object { $KeePassUuid.CompareTo($_.Uuid) -eq 0 } } else { ## This a lame way of filtering. if($KeePassGroup) { $KeePassItems = foreach($_keepassItem in $KeePassItems) { if($KeePassGroup.Contains($_keepassItem.ParentGroup)) { $_keepassItem } } } if($Title) { $KeePassItems = foreach($_keepassItem in $KeePassItems) { if($_keepassItem.Strings.ReadSafe('Title').ToLower().Equals($Title.ToLower())) { $_keepassItem } } } if($UserName) { $KeePassItems = foreach($_keepassItem in $KeePassItems) { if($_keepassItem.Strings.ReadSafe('UserName').ToLower().Equals($UserName.ToLower())) { $_keepassItem } } } $KeePassItems } } } } function Get-KPGroup { <# .SYNOPSIS Gets a KeePass Group Object. .DESCRIPTION Gets a KeePass Group Object. Type: KeePassLib.PwGroup .EXAMPLE PS> Get-KeePassGroup -KeePassConnection $Conn -FullPath 'full/KPDatabase/pathtoGroup' This Example will return a KeePassLib.PwGroup array Object with the full group path specified. .EXAMPLE PS> Get-KeePassGroup -KeePassConnection $Conn -GroupName 'Test Group' This Example will return a KeePassLib.PwGroup array Object with the groups that have the specified name. .PARAMETER KeePassConnection Specify the Open KeePass Database Connection See Get-KeePassConnection to Create the conneciton Object. .PARAMETER FullPath Specify the FullPath of a Group or Groups in a KPDB .PARAMETER GroupName Specify the GroupName of a Group or Groups in a KPDB. .PARAMETER KeePassUuid Specify the Uuid of the Group. #> [CmdletBinding(DefaultParameterSetName = 'None')] [OutputType('KeePassLib.PwGroup')] param ( [Parameter(Position = 0, Mandatory, ParameterSetName = 'Full')] [Parameter(Position = 0, Mandatory, ParameterSetName = 'Partial')] [Parameter(Position = 0, Mandatory, ParameterSetName = 'None')] [ValidateNotNullOrEmpty()] [KeePassLib.PwDatabase] $KeePassConnection, [Parameter(Position = 1, Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'Full')] [ValidateNotNullOrEmpty()] [String] $FullPath, [Parameter(Position = 1, Mandatory, ValueFromPipelineByPropertyName, ParameterSetName = 'Partial')] [ValidateNotNullOrEmpty()] [String] $GroupName, [Parameter(Position = 2)] [Switch] $Stop ) begin { try { [KeePassLib.PwGroup[]] $KeePassOutGroups = $null [KeePassLib.PwGroup[]] $KeePassGroups = $KeePassConnection.RootGroup $KeePassGroups += $KeePassConnection.RootGroup.GetFlatGroupList() } catch { Write-Warning -Message 'An error occured while getting a KeePassLib.PwGroup Object.' Write-Error -ErrorRecord $_ -ea Stop } } process { if(Test-KPConnection $KeePassConnection) { [int] $foundCount = 0 if($PSCmdlet.ParameterSetName -eq 'Full') { foreach($_keepassGroup in $KeePassGroups) { if($_keepassGroup.GetFullPath('/', $true).ToLower().Equals($FullPath.ToLower())) { $_keepassGroup $foundCount += 1 } } } elseif($PSCmdlet.ParameterSetName -eq 'Partial') { foreach($_keepassGroup in $KeePassGroups) { if($_keepassGroup.Name.ToLower().Equals($GroupName.ToLower())) { $_keepassGroup $foundCount += 1 } } } elseif($PSCmdlet.ParameterSetName -eq 'None') { $KeePassGroups $foundCount = $KeePassGroups.Count } } if($Stop -and $foundCount -eq 0) { Write-Warning -Message ('[PROCESS] The Specified KeePass Entry Group Path ({0}) does not exist.' -f $KeePassGroupParentPath) Throw 'The Specified KeePass Entry Group Path ({0}) does not exist.' -f $KeePassGroupParentPath } } } function Get-KPPasswordProfile { <# .SYNOPSIS Function to Retreive All or a Specified Password Profile. .DESCRIPTION Function to Retreive All or a Specified Password Profile from the KeePassConfiguration.xml file. .PARAMETER PasswordProfileName Specify the Password Profile Name to Retreive. .EXAMPLE PS> Get-KPPasswordProfile Returns all Password Profile definitions if any. .NOTES Internal Funciton. .INPUTS String .OUTPUTS PSObject #> [CmdletBinding()] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "PasswordProfileName")] param ( [Parameter(Position = 0)] [ValidateNotNullOrEmpty()] [String] $PasswordProfileName ) process { if(Test-Path -Path $SCRIPT:KeePassConfigurationFile) { [Xml] $XML = New-Object -TypeName System.Xml.XmlDocument $XML.Load($SCRIPT:KeePassConfigurationFile) if($PasswordProfileName) { $XML.Settings.PasswordProfiles.Profile | Where-Object { $_.Name -ilike $PasswordProfileName } } else { $XML.Settings.PasswordProfiles.Profile } } else { Write-Verbose 'No KeePass Configuration files exist, please create one to continue: New-KeePassDatabasConfiguration.' } } } function Import-KPLibrary { [CmdletBinding()] param() process { Add-Type -Path $SCRIPT:KeePassLibraryPath } } function New-KPConfigurationFile { <# .SYNOPSIS This Internal Function Creates the KeePassConfiguration.xml file. .DESCRIPTION This Internal Function Creates the KeePassConfiguration.xml file. This File is used to store database configuration for file locations, authentication settings and password profiles. .PARAMETER Force Specify this parameter to forcefully overwrite the existing config with a new fresh config. .EXAMPLE PS> New-KPConfigurationFile This Example will create a new KeePassConfiguration.xml file. .NOTES Internal Function. .INPUTS Switch .OUTPUTS $null #> [CmdletBinding()] param ( [Parameter(Position = 0)] [Switch] $Force ) process { if((Test-Path -Path $SCRIPT:KeePassConfigurationFile) -and -not $Force) { Write-Warning -Message '[PROCESS] A KeePass Configuration File already exists. Please rerun with -force to overwrite the existing configuration.' Write-Error -Message 'A KeePass Configuration File already exists.' -ea Stop } else { try { $Path = $SCRIPT:KeePassConfigurationFile $XML = New-Object System.Xml.XmlTextWriter($Path, $null) $XML.Formatting = 'Indented' $XML.Indentation = 1 $XML.IndentChar = "`t" $XML.WriteStartDocument() $XML.WriteProcessingInstruction('xml-stylesheet', "type='text/xsl' href='style.xsl'") $XML.WriteStartElement('Settings') $XML.WriteStartElement('DatabaseProfiles') $XML.WriteEndElement() $XML.WriteStartElement("PasswordProfiles") $XML.WriteEndElement() $XML.WriteEndElement() $XML.WriteEndDocument() $xml.Flush() $xml.Close() } catch { Write-Warning -Message 'An exception occured while trying to create a new keepass configuration file.' Write-Error -ErrorRecord $_ -ea Stop } } } } function New-KPConnection { <# .SYNOPSIS Creates an open connection to a Keepass database .DESCRIPTION Creates an open connection to a Keepass database using all available authentication methods .PARAMETER Database Path to the Keepass database (.kdbx file) .PARAMETER ProfileName Name of the profile entry .PARAMETER MasterKey Path to the keyfile (.key file) used to open the database .PARAMETER Keyfile Path to the keyfile (.key file) used to open the database .PARAMETER UseWindowsAccount Use the current windows account as an authentication method #> [CmdletBinding(DefaultParameterSetName = '__None')] param ( [Parameter(Position = 0, ParameterSetName = 'Profile')] [AllowNull()] [String] $DatabaseProfileName, [Parameter(Position = 0, Mandatory, ParameterSetName = 'CompositeKey')] [ValidateNotNullOrEmpty()] [String] $Database, [Parameter(Position = 2, ParameterSetName = 'CompositeKey')] [Parameter(Position = 1, ParameterSetName = 'Profile')] [AllowNull()] [PSObject] $MasterKey, [Parameter(Position = 1, ParameterSetName = 'CompositeKey')] [ValidateNotNullOrEmpty()] [String] $KeyPath, [Parameter(Position = 3, ParameterSetName = 'CompositeKey')] [Switch] $UseWindowsAccount ) process { try { $DatabaseObject = New-Object -TypeName KeepassLib.PWDatabase -ErrorAction Stop } catch { Write-Error -Message 'Unable to Create KeepassLib.PWDatabase to open a connection.' -Exception $_.Exception -ea Stop } $CompositeKey = New-Object -TypeName KeepassLib.Keys.CompositeKey if(($MasterKey -isnot [PSCredential]) -and ($MasterKey -isnot [SecureString]) -and $MasterKey) { Write-Error -Message ('[PROCESS] The MasterKey of type: ({0}). Is not Supported Please supply a MasterKey of Types (SecureString or PSCredential).' -f $($MasterKey.GetType().Name)) -Category InvalidType -TargetObject $MasterKey -RecommendedAction 'Provide a MasterKey of Type PSCredential or SecureString' } if($PSCmdlet.ParameterSetName -eq 'Profile' -or $PSCmdlet.ParameterSetName -eq '__None') { ## if not passing a profile name, attempt to get the default db $getKeePassDatabaseConfigurationSplat = @{ Stop = $true } if($DatabaseProfileName){ $getKeePassDatabaseConfigurationSplat.DatabaseProfileName = $DatabaseProfileName } else{ $getKeePassDatabaseConfigurationSplat.Default = $true } $KeepassConfigurationObject = Get-KeePassDatabaseConfiguration @getKeePassDatabaseConfigurationSplat $Database = $KeepassConfigurationObject.DatabasePath if(-not [string]::IsNullOrEmpty($KeepassConfigurationObject.KeyPath)){ $KeyPath = $KeepassConfigurationObject.KeyPath } [Switch] $UseWindowsAccount = $KeepassConfigurationObject.UseNetworkAccount [Switch] $UseMasterKey = $KeepassConfigurationObject.UseMasterKey if($UseMasterKey -and -not $MasterKey) { $MasterKey = Read-Host -Prompt 'KeePass Password' -AsSecureString } } elseif($PSCmdlet.ParameterSetName -eq 'CompositeKey') { $UseMasterKey = if($MasterKey){ $true } } if($MasterKey -is [PSCredential]) { [SecureString] $MasterKey = $MasterKey.Password } $DatabaseItem = Get-Item -Path $Database -ErrorAction Stop ## Start Building CompositeKey ## Order in which the CompositeKey is created is important and must follow the order of : MasterKey, KeyFile, Windows Account if($UseMasterKey) { $CompositeKey.AddUserKey((New-Object KeepassLib.Keys.KcpPassword([System.Runtime.InteropServices.Marshal]::PtrToStringUni([System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($MasterKey))))) } if($KeyPath) { try { $KeyPathItem = Get-Item $KeyPath -ErrorAction Stop $CompositeKey.AddUserKey((New-Object KeepassLib.Keys.KcpKeyfile($KeyPathItem.FullName))) } catch { Write-Warning ('Could not read the specfied Key file [{0}].' -f $KeyPathItem.FullName) } } if($UseWindowsAccount) { $CompositeKey.AddUserKey((New-Object KeepassLib.Keys.KcpUserAccount)) } ## Build and Open Connection $IOInfo = New-Object KeepassLib.Serialization.IOConnectionInfo $IOInfo.Path = $DatabaseItem.FullName ## We currently are not using a status logger hence the null. $IStatusLogger = New-Object KeePassLib.Interfaces.NullStatusLogger $null = $DatabaseObject.Open($IOInfo, $CompositeKey, $IStatusLogger) $DatabaseObject if(-not $DatabaseObject.IsOpen) { Throw 'InvalidDatabaseConnectionException : The database is not open.' } } } function New-KPPasswordProfile { <# .SYNOPSIS Function to save a password profile to the KeePassConfiguration.xml file. .DESCRIPTION This funciton will save a password profile to the config file. This is an internal function and is used in the -saveas option of the New-KeePassPassword function. .PARAMETER KeePassPasswordObject Specify the KeePass Password Profile Object to be saved to the config file. .EXAMPLE PS> New-KPPasswordProfile -KeePassPasswordObject $NewPasswordProfile This Example adds the $NewPasswordProfile object to the KeePassConfiguration.xml file. .NOTES Internal Funciton .INPUTS PSObject .OUTPUTS $null #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory)] [ValidateNotNullOrEmpty()] [PSCustomObject] $KeePassPasswordObject ) process { if(Test-Path -Path $SCRIPT:KeePassConfigurationFile) { $CheckIfExists = Get-KPPasswordProfile -PasswordProfileName $KeePassPasswordObject.ProfileName if($CheckIfExists) { Write-Warning -Message ('[PROCESS] A Password Profile with the specified name ({0}) already exists.' -f $KeePassPasswordObject.ProfileName) Throw 'A Password Profile with the specified name ({0}) already exists.' -f $KeePassPasswordObject.ProfileName } [Xml] $XML = New-Object -TypeName System.Xml.XmlDocument $XML.Load($SCRIPT:KeePassConfigurationFile) ## Create New Profile Element with Name of the new profile $PasswordProfile = $XML.CreateElement('Profile') $PasswordProfileAtribute = $XML.CreateAttribute('Name') $PasswordProfileAtribute.Value = $KeePassPasswordObject.ProfileName $PasswordProfile.Attributes.Append($PasswordProfileAtribute) | Out-Null ## Build and Add Element Nodes $CharacterSetNode = $XML.CreateNode('element', 'CharacterSet', '') $CharacterSetNode.InnerText = $KeePassPasswordObject.CharacterSet $PasswordProfile.AppendChild($CharacterSetNode) | Out-Null $ExcludeLookAlikeNode = $XML.CreateNode('element', 'ExcludeLookAlike', '') $ExcludeLookAlikeNode.InnerText = $KeePassPasswordObject.ExcludeLookAlike $PasswordProfile.AppendChild($ExcludeLookAlikeNode) | Out-Null $NoRepeatingCharactersNode = $XML.CreateNode('element', 'NoRepeatingCharacters', '') $NoRepeatingCharactersNode.InnerText = $KeePassPasswordObject.NoRepeatingCharacters $PasswordProfile.AppendChild($NoRepeatingCharactersNode) | Out-Null $ExcludeCharactersNode = $XML.CreateNode('element', 'ExcludeCharacters', '') $ExcludeCharactersNode.InnerText = $KeePassPasswordObject.ExcludeCharacters $PasswordProfile.AppendChild($ExcludeCharactersNode) | Out-Null $LengthNode = $XML.CreateNode('element', 'Length', '') $LengthNode.InnerText = $KeePassPasswordObject.Length $PasswordProfile.AppendChild($LengthNode) | Out-Null $XML.SelectSingleNode('/Settings/PasswordProfiles').AppendChild($PasswordProfile) | Out-Null $XML.Save($SCRIPT:KeePassConfigurationFile) } else { Write-Output 'No KeePass Database Configuration file exists. You can create one with the New-KeePassDatabaseConfiguration function.' } } } function Remove-KPConnection { <# .SYNOPSIS This Function Removes a Connection to a KeePass Database. .DESCRIPTION This Function Removes a Connection to a KeePass Database. .EXAMPLE PS> Remove-KPConnection -KeePassConnection $DB This Example will Remove/Close a KeePass Database Connection using a pre-defined KeePass DB connection. .PARAMETER KeePassConnection This is the KeePass Connection to be Closed #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory)] [ValidateNotNullOrEmpty()] [KeePassLib.PwDatabase] $KeePassConnection ) process { try { if($KeePassConnection.IsOpen) { $KeePassConnection.Close() } else { Write-Warning -Message '[PROCESS] The KeePass Database Specified is already closed or does not exist.' Write-Error -Message 'The KeePass Database Specified is already closed or does not exist.' -ea Stop } } catch [Exception] { Write-Warning -Message ('[PROCESS] {0}' -f $_.Exception.Message) Write-Error -ErrorRecord $_ -ea Stop } } } function Remove-KPEntry { <# .SYNOPSIS Remove a Specific KeePass Entry. .DESCRIPTION Remove a Specified KeePass Database Entry. .PARAMETER KeePassConnection This is the Open KeePass Database Connection See Get-KPConnection to Create the conneciton Object. .PARAMETER KeePassEntry This is the KeePass Entry Object to be deleted. .PARAMETER NoRecycle Specify this flag to Permanently delete an entry. (ei skip the recycle bin) .PARAMETER Force Specify this flag to forcefully delete an entry. .EXAMPLE PS> Remove-KPEntry -KeePassConnection $KeePassConnectionObject -KeePassEntry $KeePassEntryObject This Will remove a keepass database entry and prompt for confirmation. .INPUTS Strings KeePassLib.PwDatabase KeePassLib.PwEntry Switch .OUTPUTS $null #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNull()] [KeePassLib.PwDatabase] $KeePassConnection, [Parameter(Position = 1, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [KeePassLib.PwEntry] $KeePassEntry, [Parameter(Position = 2)] [Switch] $NoRecycle, [Parameter(Position = 3)] [Switch] $Force ) begin { if($KeePassConnection.RecycleBinEnabled) { $RecycleBin = $KeePassConnection.RootGroup.FindGroup($KeePassConnection.RecycleBinUuid, $true) if(-not $RecycleBin) { $RecycleBin = New-Object -TypeName KeePassLib.PwGroup($true, $true, 'RecycleBin', 43) $RecycleBin.EnableAutoType = $false $RecycleBin.EnableSearching = $false $KeePassConnection.RootGroup.AddGroup($RecycleBin, $true) $KeePassConnection.RecycleBinUuid = $RecycleBin.Uuid $KeePassConnection.Save($null) $RecycleBin = $KeePassConnection.RootGroup.FindGroup($KeePassConnection.RecycleBinUuid, $true) } } $EntryDisplayName = "$($KeePassEntry.ParentGroup.GetFullPath('/', $true))/$($KeePassEntry.Strings.ReadSafe('Title'))" } process { if(Test-KPConnection $KeePassConnection) { if($Force -or $PSCmdlet.ShouldProcess($($EntryDisplayName))) { if($RecycleBin -and -not $NoRecycle) { ## Make Copy of the group to be recycled. $DeletedKeePassEntry = $KeePassEntry.CloneDeep() ## Generate a new Uuid and update the copy fo the group $DeletedKeePassEntry.Uuid = (New-Object KeePassLib.PwUuid($true)) ## Add the copy to the recycle bin, with take ownership set to true $RecycleBin.AddEntry($DeletedKeePassEntry, $true) ## Save for safety $KeePassConnection.Save($null) ## Delete Original Entry $KeePassEntry.ParentGroup.Entries.Remove($KeePassEntry) > $null ## Save again $KeePassConnection.Save($null) Write-Verbose -Message "[PROCESS] Group has been Recycled." } else { if($Force -or $PSCmdlet.ShouldContinue("Recycle Bin Does Not Exist or the -NoRecycle Option Has been Specified.", "Do you want to continue to Permanently Delete this Entry: ($($EntryDisplayName))?")) { ## Deletes the specified group $IsRemoved = $KeePassEntry.ParentGroup.Entries.Remove($KeePassEntry) if(-not $IsRemoved) { Write-Warning -Message "[PROCESS] Unknown Error has occured. Failed to Remove Entry ($($EntryDisplayName))" Throw "Failed to Remove Entry $($EntryDisplayName)" } else { Write-Verbose -Message "[PROCESS] Entry ($($EntryDisplayName)) has been Removed." $KeePassConnection.Save($null) } } } } } } } function Remove-KPGroup { <# .SYNOPSIS Function to remove a KeePass Group .DESCRIPTION Function to remove a specified KeePass Group. .PARAMETER KeePassConnection This is the Open KeePass Database Connection See Get-KeePassConnection to Create the conneciton Object. .PARAMETER KeePassGroup Specify the Group to be removed. .PARAMETER NoRecycle Specify if you do not want the group to go to the Recycle Bin. .PARAMETER Force Specify to forcefully remove a group. .EXAMPLE PS> Remove-KPGroup -KeePassConnection $KeePassConnectionObject -KeePassGroup $KeePassGroupObject Removes the specified account. Prompts before deletion and will put to recyclebin if there is one. .INPUTS KeePassLib.PwDatabase KeePassLib.PwGroup Switch .OUTPUTS $null #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNull()] [KeePassLib.PwDatabase] $KeePassConnection, [Parameter(Position = 1, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [KeePassLib.PwGroup] $KeePassGroup, [Parameter(Position = 2)] [Switch] $NoRecycle, [Parameter(Position = 3)] [Switch] $Force ) begin { if($KeePassConnection.RecycleBinEnabled) { $RecycleBin = $KeePassConnection.RootGroup.FindGroup($KeePassConnection.RecycleBinUuid, $true) if(-not $RecycleBin) { $RecycleBin = New-Object -TypeName KeePassLib.PwGroup($true, $true, 'RecycleBin', 43) $RecycleBin.EnableAutoType = $false $RecycleBin.EnableSearching = $false $KeePassConnection.RootGroup.AddGroup($RecycleBin, $true) $KeePassConnection.RecycleBinUuid = $RecycleBin.Uuid $KeePassConnection.Save($null) $RecycleBin = $KeePassConnection.RootGroup.FindGroup($KeePassConnection.RecycleBinUuid, $true) } } } process { if(Test-KPConnection $KeePassConnection) { if($Force -or $PSCmdlet.ShouldProcess($($KeePassGroup.GetFullPath('/', $true)))) { if($RecycleBin -and -not $NoRecycle) { ## Make Copy of the group to be recycled. $DeletedKeePassGroup = $KeePassGroup.CloneDeep() ## Generate a new Uuid and update the copy fo the group $DeletedKeePassGroup.Uuid = (New-Object KeePassLib.PwUuid($true)) ## Add the copy to the recycle bin, with take ownership set to true $RecycleBin.AddGroup($DeletedKeePassGroup, $true, $true) $KeePassConnection.Save($null) $KeePassGroup.ParentGroup.Groups.Remove($KeePassGroup) > $null $KeePassConnection.Save($null) Write-Verbose -Message '[PROCESS] Group has been Recycled.' } else { if($Force -or $PSCmdlet.ShouldContinue('Recycle Bin Does Not Exist or the -NoRecycle Option Has been Specified.', "Do you want to continue to Permanently Delete this Group: ($($KeePassGroup.GetFullPath('/', $true)))?")) { ## Deletes the specified group $IsRemoved = $KeePassGroup.ParentGroup.Groups.Remove($KeePassGroup) if(-not $IsRemoved) { Write-Warning -Message ('[PROCESS] Unknown Error has occured. Failed to Remove Group ({0})' -f $KeePassGroup.GetFullPath('/', $true)) Throw 'Failed to Remove Group ({0})' -f $KeePassGroup.GetFullPath('/', $true) } else { Write-Verbose -Message ('[PROCESS] Group ({0}) has been Removed.' -f $KeePassGroup.GetFullPath('/', $true)) $KeePassConnection.Save($null) } } } } } } } function Remove-KPPasswordProfile { <# .SYNOPSIS Function to remove a specifed Password Profile. .DESCRIPTION Removes a specified password profile from the KeePassConfiguration.xml file. .PARAMETER PasswordProfileName Specify the Password Profile to be delete from the config file. .EXAMPLE PS> Remove-KPPasswordProfile -PasswordProfileName 'Personal' This example remove the password profile with the name 'Personal' .NOTES Internal Funciton. .INPUTS Strings .OUTPUTS $null #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "PasswordProfileName")] param ( [Parameter(Position = 0, Mandatory, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [String] $PasswordProfileName ) begin { } process { if(-not (Test-Path -Path $SCRIPT:KeePassConfigurationFile)) { Write-Verbose -Message '[PROCESS] A KeePass Configuration File does not exist.' } else { if($PSCmdlet.ShouldProcess($PasswordProfileName)) { try { [Xml] $XML = New-Object -TypeName System.Xml.XmlDocument $XML.Load($SCRIPT:KeePassConfigurationFile) $XML.Settings.PasswordProfiles.Profile | Where-Object { $_.Name -eq $PasswordProfileName } | ForEach-Object { $xml.Settings.PasswordProfiles.RemoveChild($_) } | Out-Null $XML.Save($SCRIPT:KeePassConfigurationFile) } catch [exception] { Write-Warning -Message ('[PROCESS] An exception occured while attempting to remove a KeePass Password Profile ({0}).' -f $PasswordProfileName) Write-Warning -Message ('[PROCESS] {0}' -f $_.Exception.Message) Throw $_ } } } } } function Restore-KPConfigurationFile { <# .SYNOPSIS Restore Config file from previous version .DESCRIPTION Restore Config file from previous version .PARAMETER .EXAMPLE .NOTES .INPUTS .OUTPUTS #> [CmdletBinding()] param ( [Parameter(Position = 0)] [String] $BreakingChangesVersion ) process { $ReturnStatus = $false $Path = Resolve-Path -Path ('{0}\..' -f $PSScriptRoot) Write-Verbose -Message ('[PROCESS] Checking if there is a previous KeePassConfiguration.xml file to be loaded from: {0}.' -f $Path.Path ) $PreviousVersion = ((Get-ChildItem $Path.Path).Name | Sort-Object -Descending | Select-Object -First 2)[1] Write-Verbose -Message ('PreviousVersion: {0}.' -f $PreviousVersion) $PreviousVersionConfigurationFile = Resolve-Path -Path ('{0}\..\{1}\KeePassConfiguration.xml' -f $PSScriptRoot, $PreviousVersion) -ErrorAction SilentlyContinue -ErrorVariable GetPreviousConfigurationFileError if(-not $GetPreviousConfigurationFileError -and $PreviousVersion) { Write-Verbose -Message ('[PROCESS] Copying last Configuration file from the previous version ({0}).' -f $PreviousVersion) Copy-Item -Path $PreviousVersionConfigurationFile -Destination "$PSScriptRoot" -ErrorAction SilentlyContinue -ErrorVariable RestorePreviousConfigurationFileError if($RestorePreviousConfigurationFileError) { Write-Warning -Message '[PROCESS] Unable to restore previous KeePassConfiguration.xml file. You will need to copy your previous file from your previous module version folder or create a new one.' } else { $ReturnStatus = $true } } return $ReturnStatus } } function Set-KPEntry { <# .SYNOPSIS This Function will update a entry. .DESCRIPTION This Function will update a entry. Currently This function supportes the basic fields for a KeePass Entry. .PARAMETER KeePassConnection This is the Open KeePass Database Connection See Get-KeePassConnection to Create the conneciton Object. .PARAMETER KeePassEntry This is the KeePass Entry Object to update/set atrributes. .PARAMETER KeePassGroup Specifiy this if you want Move the KeePassEntry to another Group .PARAMETER Title This is the Title to update/set. .PARAMETER UserName This is the UserName to update/set. .PARAMETER KeePassPassword This is the Password to update/set. .PARAMETER Notes This is the Notes to update/set. .PARAMETER URL This is the URL to update/set. .PARAMETER PassThru Returns the updated KeePass Entry after updating. .PARAMETER Force Specify to force updating the KeePass Entry. .PARAMETER IconName Specify the Name of the Icon for the Entry to display in the KeePass UI. .PARAMETER Expires Specify if you want the KeePass Object to Expire, default is to not expire. .PARAMETER ExpiryTime Datetime expiration Time value. .NOTES This Cmdlet will autosave on exit #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, Mandatory)] [ValidateNotNullOrEmpty()] [KeePassLib.PwDatabase] $KeePassConnection, [Parameter(Position = 1, Mandatory)] [ValidateNotNullOrEmpty()] [KeePassLib.PwEntry] $KeePassEntry, [Parameter(Position = 2)] [String] $Title, [Parameter(Position = 3)] [String] $UserName, [Parameter(Position = 4)] [PSObject] $KeePassPassword, [Parameter(Position = 5)] [String] $Notes, [Parameter(Position = 6)] [String] $URL, [Parameter(Position = 7)] [ValidateNotNullOrEmpty()] [KeePassLib.PwGroup] $KeePassGroup, [Parameter(Position = 8)] [KeePassLib.PwIcon] $IconName, [Parameter(Position = 9)] [bool] $Expires, [Parameter(Position = 10)] [DateTime] $ExpiryTime, [Parameter(Position = 11)] [Switch] $PassThru, [Parameter(Position = 12)] [Switch] $Force ) process { if((Test-KPPasswordValue $KeePassPassword) -and (Test-KPConnection $KeePassConnection)) { if($Force -or $PSCmdlet.ShouldProcess("Title: $($KeePassEntry.Strings.ReadSafe('Title')). `n`tUserName: $($KeePassEntry.Strings.ReadSafe('UserName')). `n`tGroup Path $($KeePassEntry.ParentGroup.GetFullPath('/', $true))")) { [KeePassLib.PwEntry] $OldEntry = $KeePassEntry.CloneDeep() if($Title) { $SecureTitle = New-Object KeePassLib.Security.ProtectedString($KeePassConnection.MemoryProtection.ProtectTitle, $Title) $KeePassEntry.Strings.Set('Title', $SecureTitle) } if($UserName) { $SecureUser = New-Object KeePassLib.Security.ProtectedString($KeePassConnection.MemoryProtection.ProtectUserName, $UserName) $KeePassEntry.Strings.Set('UserName', $SecureUser) } if($KeePassPassword) { if($KeePassPassword.GetType().Name -eq 'SecureString') { $KeePassSecurePasswordString = New-Object KeePassLib.Security.ProtectedString $KeePassSecurePasswordString = $KeePassSecurePasswordString.Insert(0, [Runtime.InteropServices.Marshal]::PtrToStringAuto([Runtime.InteropServices.Marshal]::SecureStringToBSTR($KeePassPassword))).WithProtection($true) } elseif($KeePassPassword.GetType().Name -eq 'ProtectedString') { $KeePassSecurePasswordString = $KeePassPassword } $KeePassEntry.Strings.Set('Password', $KeePassSecurePasswordString) } if($Notes) { $SecureNotes = New-Object KeePassLib.Security.ProtectedString($KeePassConnection.MemoryProtection.ProtectNotes, $Notes) $KeePassEntry.Strings.Set('Notes', $SecureNotes) } if($URL) { $SecureURL = New-Object KeePassLib.Security.ProtectedString($KeePassConnection.MemoryProtection.ProtectUrl, $URL) $KeePassEntry.Strings.Set('URL', $SecureURL) } if($IconName -and $IconName -ne $KeePassEntry.IconId) { $KeePassEntry.IconId = $IconName } if(Test-Bound -ParameterName 'Expires') { $KeePassEntry.Expires = $Expires } if($ExpiryTime) { $KeePassEntry.ExpiryTime = $ExpiryTime.ToUniversalTime() } $OldEntry.History.clear() $KeePassEntry.History.Add($OldEntry) if($KeePassGroup) { $OldKeePassGroup = $KeePassEntry.ParentGroup ## Add to group and move $KeePassGroup.AddEntry($KeePassEntry, $true, $true) ## delete old entry $null = $OldKeePassGroup.Entries.Remove($KeePassEntry) } ## Add History Entry $KeePassEntry.LastModificationTime = [DateTime]::UtcNow $KeePassEntry.LastAccessTime = [DateTime]::UtcNow ## Save for safety $KeePassConnection.Save($null) if($PassThru) { $KeePassEntry } } } } } function Set-KPGroup { <# .SYNOPSIS Creates a New KeePass Folder Group. .DESCRIPTION Creates a New KeePass Folder Group. .EXAMPLE PS> Add-KPGroup -KeePassConnection $Conn -GroupName 'NewGroupName' -KeePassParentGroup $KpGroup This Example Create a New Group with the specified name in the specified KeePassParentGroup. .PARAMETER KeePassConnection This is the Open KeePass Database Connection See Get-KeePassConnection to Create the conneciton Object. .PARAMETER GroupName Specify the name of the new group(s). .PARAMETER KeePassParentGroup Sepcify the KeePassParentGroup(s) for the new Group(s). .PARAMETER IconName Specify the Name of the Icon for the Entry to display in the KeePass UI. .PARAMETER Notes Specify group notes .PARAMETER PassThru Specify to return the updated group object. .PARAMETER Force Specify to force updating the group. .PARAMETER Expires Specify if you want the KeePass Object to Expire, default is to not expire. .PARAMETER ExpiryTime Datetime expiration Time value. .NOTES This Cmdlet Does AutoSave on exit. #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Position = 0, Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNull()] [KeePassLib.PwDatabase] $KeePassConnection, [Parameter(Position = 1, Mandatory)] [ValidateNotNullOrEmpty()] [KeePassLib.PwGroup] $KeePassGroup, [Parameter(Position = 2)] [String] $GroupName, [Parameter(Position = 3)] [ValidateNotNullOrEmpty()] [KeePassLib.PwGroup] $KeePassParentGroup, [Parameter(Position = 4)] [KeePassLib.PwIcon] $IconName, [Parameter(Position = 5)] [String] $Notes, [Parameter(Position = 6)] [bool] $Expires, [Parameter(Position = 7)] [DateTime] $ExpiryTime, [Parameter(Position = 8)] [Switch] $PassThru, [Parameter(Position = 9)] [Switch] $Force ) process { if(Test-KPConnection $KeePassConnection) { if($Force -or $PSCmdlet.ShouldProcess($($KeePassGroup.GetFullPath('/', $true)))) { if($GroupName) { $KeePassGroup.Name = $GroupName } if($IconName -and $IconName -ne $KeePassGroup.IconId) { $KeePassGroup.IconId = $IconName } if($Notes) { $KeePassGroup.Notes = $Notes } if(Test-Bound -ParameterName 'Expires') { $KeePassGroup.Expires = $Expires } if($ExpiryTime) { $KeePassGroup.ExpiryTime = $ExpiryTime.ToUniversalTime() } if($KeePassParentGroup) { if($KeePassGroup.ParentGroup.Uuid.CompareTo($KeePassParentGroup.Uuid) -ne 0 ) { $UpdatedKeePassGroup = $KeePassGroup.CloneDeep() $UpdatedKeePassGroup.Uuid = New-Object KeePassLib.PwUuid($true) $KeePassParentGroup.AddGroup($UpdatedKeePassGroup, $true, $true) $KeePassConnection.Save($null) $KeePassGroup.ParentGroup.Groups.Remove($KeePassGroup) > $null $KeePassConnection.Save($null) $KeePassGroup = $UpdatedKeePassGroup } } $KeePassConnection.Save($null) if($PassThru) { $KeePassGroup } } } } } ## Taken and Modified from DBATools function Test-Bound { <# .SYNOPSIS Helperfunction that tests, whether a parameter was bound. .DESCRIPTION Helperfunction that tests, whether a parameter was bound. .PARAMETER ParameterName The name(s) of the parameter that is tested for being bound. By default, the check is true when AT LEAST one was bound. .PARAMETER Not Reverses the result. Returns true if NOT bound and false if bound. .PARAMETER And All specified parameters must be present, rather than at least one of them. .PARAMETER BoundParameters The hashtable of bound parameters. Is automatically inherited from the calling function via default value. Needs not be bound explicitly. #> [CmdletBinding()] param ( [Parameter(Position = 0, Mandatory)] [string[]] $ParameterName, [Alias('Reverse')] [switch] $Not, [switch] $And, [object] $BoundParameters = (Get-PSCallStack)[0].InvocationInfo.BoundParameters ) process { if($And) { $test = $true } else { $test = $false } foreach($name in $ParameterName) { if($And) { if(-not $BoundParameters.ContainsKey($name)) { $test = $false } } else { if($BoundParameters.ContainsKey($name)) { $test = $true } } } return ((-not $Not) -eq $test) } } function Test-KPConnection { [cmdletbinding()] param ( [Parameter(Position = 0)] [AllowNull()] [AllowEmptyString()] [PSObject] $KeePassConnection ) if($KeePassConnection.IsOpen) { $true } else { $false Write-Warning -Message 'The KeePass Connection Sepcified is not open or does not exist.' Write-Error -Message 'The KeePass Connection Sepcified is not open or does not exist.' -ea Stop } } function Test-KPPasswordValue { [cmdletbinding()] param ( [Parameter(Position = 0)] [AllowNull()] [AllowEmptyString()] [PSObject] $KeePassPassword ) if(-not $KeePassPassword) { $true } elseif($KeePassPassword.GetType().Name -eq 'SecureString') { $true } elseif($KeePassPassword.GetType().Name -eq 'ProtectedString') { $true } else { $false Write-Warning -Message '[PROCESS] Please provide a KeePassPassword of Type SecureString or KeePassLib.Security.ProtectedString.' Write-Warning -Message ('[PROCESS] The Value supplied ({0}) is of Type {1}.' -f $KeePassPassword, $KeePassPassword.GetType().Name) Write-Error -Message 'Please provide a KeePassPassword of Type SecureString or KeePassLib.Security.ProtectedString.' -ea Stop } } $KeePassRoot = "$($ENV:LOCALAPPDATA)/KeePass" if (-not (Test-Path $KeePassRoot)) {New-Item -ItemType Directory -Path $KeePassRoot} [String] $SCRIPT:KeePassConfigurationFile = "$KeePassRoot/KeePassConfiguration.xml" [String] $SCRIPT:KeePassLibraryPath = '{0}\bin\*.dll' -f $PSScriptRoot ## Source KpLib Import-KPLibrary ## Check fo config and init if (-not(Test-Path -Path $SCRIPT:KeePassConfigurationFile)) { Write-Warning -Message '**IMPORTANT NOTE:** Please always keep an up-to-date backup of your keepass database files and key files if used.' $Versions = ((Get-ChildItem "$PSScriptRoot\..").Name | Sort-Object -Descending) if(-not $(Restore-KPConfigurationFile)) { New-KPConfigurationFile $previousVersion = [int]($Versions[1] -replace '\.') $CurrentVersion = $Versions[0] if($previousVersion -lt 2124) { Write-Warning -Message ('**BREAKING CHANGES:** This new version of the module {0} contains BREAKING CHANGES, please review the changelog or readme for details!' -f $CurrentVersion) } Write-Warning -Message 'This message will not show again on next import.' } } else { New-Variable -Name 'KeePassProfileNames' -Value @((Get-KeePassDatabaseConfiguration).Name) -Scope 'Script' #-Option Constant } Export-ModuleMember * if(Get-Command Register-ArgumentCompleter -ea 0) { Register-ArgumentCompleter -ParameterName 'DatabaseProfileName' -ScriptBlock { param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter) Get-KeePassDatabaseConfiguration | Where-Object { $_.Name -ilike "${wordToComplete}*" } | ForEach-Object { New-Object System.Management.Automation.CompletionResult ( $_.Name, $_.Name, 'ParameterValue', $_.Name) } } Register-ArgumentCompleter -ParameterName 'IconName' -ScriptBlock { param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter) [KeePassLib.PwIcon].GetEnumValues() | Where-Object { $_ -ilike "${wordToComplete}*" } | ForEach-Object { New-Object System.Management.Automation.CompletionResult ( $_, $_, 'ParameterValue', $_) } } Register-ArgumentCompleter -ParameterName 'PasswordProfileName' -ScriptBlock { param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter) (Get-KPPasswordProfile).Name | Where-Object { $_ -ilike "${wordToComplete}*" } | ForEach-Object { New-Object System.Management.Automation.CompletionResult ( $_, $_, 'ParameterValue', $_) } } } |