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
|
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Reflection;
using System.Text.RegularExpressions;
using System.Windows.Forms;
using Jayrock.JsonRpc;
using KeePass;
using KeePass.Resources;
using KeePass.Util;
using KeePassLib;
using KeePassLib.Collections;
using KeePassLib.Cryptography.PasswordGenerator;
using KeePassLib.Security;
using KeePassLib.Serialization;
using KeePassLib.Utility;
using KeePassRPC.Models.DataExchange;
using KeePassRPC.Models.DataExchange.V2;
using KeePassRPC.Models.Persistent;
using KeePassRPC.Models.Shared;
using Group = KeePassRPC.Models.DataExchange.Group;
namespace KeePassRPC
{
public partial class KeePassRPCService
{
/// <summary>
/// Launches the group editor.
/// </summary>
/// <param name="uuid">The UUID of the group to edit.</param>
/// <param name="dbFileName">DB filename</param>
[JsonRpcMethod]
public void LaunchGroupEditor(string uuid, string dbFileName)
{
// Make sure there is an active database
if (!EnsureDBisOpen()) return;
// find the database
PwDatabase db = SelectDatabase(dbFileName);
if (uuid != null && uuid.Length > 0)
{
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(uuid));
PwGroup matchedGroup = GetRootPwGroup(db).FindGroup(pwuuid, true);
if (matchedGroup == null)
throw new Exception("Could not find requested entry.");
_host.MainWindow.BeginInvoke(new dlgOpenGroupEditorWindow(openGroupEditorWindow), matchedGroup, db);
}
}
/// <summary>
/// Launches the login editor.
/// </summary>
/// <param name="uuid">The UUID of the entry to edit.</param>
/// <param name="dbFileName">DB filename</param>
[JsonRpcMethod]
public void LaunchLoginEditor(string uuid, string dbFileName)
{
// Make sure there is an active database
if (!EnsureDBisOpen()) return;
// find the database
PwDatabase db = SelectDatabase(dbFileName);
if (uuid != null && uuid.Length > 0)
{
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(uuid));
PwEntry matchedLogin = GetRootPwGroup(db).FindEntry(pwuuid, true);
if (matchedLogin == null)
throw new Exception("Could not find requested entry.");
_host.MainWindow.BeginInvoke(new dlgOpenLoginEditorWindow(OpenLoginEditorWindow), matchedLogin, db);
}
}
#region Configuration of KeePass/Kee and databases
[JsonRpcMethod]
public Configuration GetCurrentKFConfig()
{
bool autoCommit = _host.CustomConfig.GetBool("KeePassRPC.KeeFox.autoCommit", true);
string[] MRUList = new string[_host.MainWindow.FileMruList.ItemCount];
for (uint i = 0; i < _host.MainWindow.FileMruList.ItemCount; i++)
MRUList[i] = ((IOConnectionInfo)_host.MainWindow.FileMruList.GetItem(i).Value).Path;
Configuration currentConfig = new Configuration(MRUList, autoCommit);
return currentConfig;
}
[JsonRpcMethod]
public ApplicationMetadata GetApplicationMetadata()
{
string KeePassVersion;
bool IsMono = false;
string NETCLR;
string NETversion;
string MonoVersion = "unknown";
// No point in outputting KeePassRPC version here since we know it has
// to match in order to be able to call this function
NETCLR = Environment.Version.Major.ToString();
KeePassVersion = PwDefs.VersionString;
Type type = Type.GetType("Mono.Runtime");
if (type != null)
{
IsMono = true;
NETversion = "";
try
{
MethodInfo displayName = type.GetMethod("GetDisplayName",
BindingFlags.NonPublic | BindingFlags.Static);
if (displayName != null)
MonoVersion = (string)displayName.Invoke(null, null);
}
catch (Exception)
{
MonoVersion = "unknown";
}
}
else
{
// Normally looking in the registry is the thing to try here but that means pulling
// in lots of Win32 libraries into Mono so this alternative gets us some useful,
// albeit incomplete, information. There shouldn't be any need to call this service
// on a regular basis so it shouldn't matter that the use of reflection is a little inefficient
// v3.0 is of no interest to us and difficult to detect so we ignore
// it and bundle those users in the v2 group
NETversion =
IsNet451OrNewer() ? "4.5.1" :
IsNet45OrNewer() ? "4.5" :
NETCLR == "4" ? "4.0" :
IsNet35OrNewer() ? "3.5" :
NETCLR == "2" ? "2.0" :
"unknown";
}
ApplicationMetadata appMetadata =
new ApplicationMetadata(KeePassVersion, IsMono, NETCLR, NETversion, MonoVersion);
return appMetadata;
}
#endregion
#region Retrival and manipulation of databases and the KeePass app
[JsonRpcMethod]
public string GetDatabaseName()
{
if (!_host.Database.IsOpen)
return "";
return (_host.Database.Name.Length > 0 ? _host.Database.Name : "no name");
}
[JsonRpcMethod]
public string GetDatabaseFileName()
{
return _host.Database.IOConnectionInfo.Path;
}
/// <summary>
/// Focuses KeePass with a database, opening it first if required
/// </summary>
/// <param name="fileName">Path to database to open. If empty, user is prompted to choose a file</param>
[JsonRpcMethod]
public void OpenAndFocusDatabase(string fileName)
{
IOConnectionInfo ioci = SelectActiveDatabase(fileName);
OpenIfRequired(ioci, false);
}
/// <summary>
/// changes current active database
/// </summary>
/// <param name="fileName">Path to database to open. If empty, user is prompted to choose a file</param>
/// <param name="closeCurrent">if true, currently active database is closed first. if false,
/// both stay open with fileName DB active</param>
[JsonRpcMethod]
public void ChangeDatabase(string fileName, bool closeCurrent)
{
if (closeCurrent && _host.MainWindow.DocumentManager.ActiveDatabase != null &&
_host.MainWindow.DocumentManager.ActiveDatabase.IsOpen)
{
_host.MainWindow.DocumentManager.CloseDatabase(_host.MainWindow.DocumentManager.ActiveDatabase);
}
IOConnectionInfo ioci = SelectActiveDatabase(fileName);
OpenIfRequired(ioci, true);
}
/// <summary>
/// notifies KeePass of a change in current location. The location in the KeePass config file
/// is updated and current databse state is modified if applicable
/// </summary>
/// <param name="locationId">New location identifier (e.g. "work", "home") Case insensitive</param>
[JsonRpcMethod]
public void ChangeLocation(string locationId)
{
if (string.IsNullOrEmpty(locationId))
return;
locationId = locationId.ToLower();
_host.CustomConfig.SetString("KeePassRPC.currentLocation", locationId);
_host.MainWindow.Invoke((MethodInvoker)delegate { _host.MainWindow.SaveConfig(); });
// tell all RPC clients they need to refresh their representation of the KeePass data
if (_host.Database.IsOpen)
_keePassRpcPlugin.SignalAllManagedRPCClients(Signal.DATABASE_SELECTED);
}
/// <summary>
/// Gets a list of all password profiles available in the current KeePass instance
/// </summary>
[JsonRpcMethod]
public string[] GetPasswordProfiles()
{
List<PwProfile> profiles = PwGeneratorUtil.GetAllProfiles(true);
List<string> profileNames = new List<string>(profiles.Count);
foreach (PwProfile prof in profiles)
profileNames.Add(prof.Name);
return profileNames.ToArray();
}
[JsonRpcMethod]
public string GeneratePassword(string profileName, string url)
{
PwProfile profile = null;
if (string.IsNullOrEmpty(profileName))
profile = Program.Config.PasswordGenerator.LastUsedProfile;
else
{
foreach (PwProfile pp in PwGeneratorUtil.GetAllProfiles(false))
{
if (pp.Name == profileName)
{
profile = pp;
Program.Config.PasswordGenerator.LastUsedProfile = pp;
break;
}
}
}
if (profile == null)
return "";
ProtectedString newPassword = new ProtectedString();
PwGenerator.Generate(out newPassword, profile, null, _host.PwGeneratorPool);
var password = newPassword.ReadString();
if (_host.CustomConfig.GetBool("KeePassRPC.KeeFox.backupNewPasswords", true))
AddPasswordBackupLogin(password, url);
return password;
}
#endregion
#region Removal of entries and groups by UUID (config V1 and V2)
/// <summary>
/// removes a single entry from the database
/// </summary>
/// <param name="uuid">The unique indentifier of the entry we want to remove</param>
/// <returns>true if entry removed successfully, false if it failed</returns>
[JsonRpcMethod]
public bool RemoveEntry(string uuid)
{
// Make sure there is an active database
if (!EnsureDBisOpen()) return false;
if (uuid != null && uuid.Length > 0)
{
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(uuid));
PwEntry matchedLogin = GetRootPwGroup(_host.Database).FindEntry(pwuuid, true);
if (matchedLogin == null)
throw new Exception("Could not find requested entry.");
PwGroup matchedLoginParent = matchedLogin.ParentGroup;
if (matchedLoginParent == null) return false; // Can't remove
matchedLoginParent.Entries.Remove(matchedLogin);
PwGroup recycleBin = _host.Database.RootGroup.FindGroup(_host.Database.RecycleBinUuid, true);
if (_host.Database.RecycleBinEnabled == false)
{
if (!MessageService.AskYesNo(KPRes.DeleteEntriesQuestionSingle,
KPRes.DeleteEntriesTitleSingle))
return false;
PwDeletedObject pdo = new PwDeletedObject();
pdo.Uuid = matchedLogin.Uuid;
pdo.DeletionTime = DateTime.Now;
_host.Database.DeletedObjects.Add(pdo);
}
else
{
if (recycleBin == null)
{
recycleBin = new PwGroup(true, true, KPRes.RecycleBin, PwIcon.TrashBin);
recycleBin.EnableAutoType = false;
recycleBin.EnableSearching = false;
_host.Database.RootGroup.AddGroup(recycleBin, true);
_host.Database.RecycleBinUuid = recycleBin.Uuid;
}
recycleBin.AddEntry(matchedLogin, true);
matchedLogin.Touch(false);
}
//matchedLogin.ParentGroup.Entries.Remove(matchedLogin);
_host.MainWindow.BeginInvoke(new dlgSaveDB(saveDB), _host.Database);
return true;
}
return false;
}
/// <summary>
/// removes a single group and its contents from the database
/// </summary>
/// <param name="uuid">The unique indentifier of the group we want to remove</param>
/// <returns>true if group removed successfully, false if it failed</returns>
[JsonRpcMethod]
public bool RemoveGroup(string uuid)
{
// Make sure there is an active database
if (!EnsureDBisOpen()) return false;
if (uuid != null && uuid.Length > 0)
{
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(uuid));
PwGroup matchedGroup = GetRootPwGroup(_host.Database).FindGroup(pwuuid, true);
if (matchedGroup == null)
throw new Exception("Could not find requested entry.");
PwGroup matchedGroupParent = matchedGroup.ParentGroup;
if (matchedGroupParent == null) return false; // Can't remove
matchedGroupParent.Groups.Remove(matchedGroup);
PwGroup recycleBin = _host.Database.RootGroup.FindGroup(_host.Database.RecycleBinUuid, true);
if (_host.Database.RecycleBinEnabled == false)
{
if (!MessageService.AskYesNo(KPRes.DeleteGroupQuestion, KPRes.DeleteGroupTitle))
return false;
PwDeletedObject pdo = new PwDeletedObject();
pdo.Uuid = matchedGroup.Uuid;
pdo.DeletionTime = DateTime.Now;
_host.Database.DeletedObjects.Add(pdo);
}
else
{
if (recycleBin == null)
{
recycleBin = new PwGroup(true, true, KPRes.RecycleBin, PwIcon.TrashBin);
recycleBin.EnableAutoType = false;
recycleBin.EnableSearching = false;
_host.Database.RootGroup.AddGroup(recycleBin, true);
_host.Database.RecycleBinUuid = recycleBin.Uuid;
}
recycleBin.AddGroup(matchedGroup, true);
matchedGroup.Touch(false);
}
_host.MainWindow.BeginInvoke(new dlgSaveDB(saveDB), _host.Database);
return true;
}
return false;
}
#endregion
#region V1 Retrival and manipulation of entries and groups
/// <summary>
/// Add a new password/login to the active KeePass database
/// </summary>
/// <param name="login">The KeePassRPC representation of the login to be added</param>
/// <param name="parentUUID">The UUID of the parent group for the new login. If null, the root group will be used.</param>
/// <param name="dbFileName">The file name of the database we want to save this entry to;
/// if empty or null, the currently active database is used</param>
[JsonRpcMethod]
public Entry AddLogin(Entry login, string parentUUID, string dbFileName)
{
// Make sure there is an active database
if (!EnsureDBisOpen()) return null;
PwEntry newLogin = new PwEntry(true, true);
setPwEntryFromEntry(newLogin, login);
// find the database
PwDatabase chosenDB = SelectDatabase(dbFileName);
PwGroup parentGroup = GetRootPwGroup(chosenDB); // if in doubt we'll stick it in the root folder
if (parentUUID != null && parentUUID.Length > 0)
{
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(parentUUID));
PwGroup matchedGroup = GetRootPwGroup(chosenDB).FindGroup(pwuuid, true);
if (matchedGroup != null)
parentGroup = matchedGroup;
}
parentGroup.AddEntry(newLogin, true);
if (_host.CustomConfig.GetBool("KeePassRPC.KeeFox.editNewEntries", false))
_host.MainWindow.BeginInvoke(new dlgOpenLoginEditorWindow(OpenLoginEditorWindow), newLogin, chosenDB);
else
_host.MainWindow.BeginInvoke(new dlgSaveDB(saveDB), chosenDB);
Entry output = (Entry)GetEntryFromPwEntry(newLogin, MatchAccuracy.Best, true, chosenDB);
return output;
}
/// <summary>
/// Add a new group/folder to the active KeePass database
/// </summary>
/// <param name="name">The name of the group to be added</param>
/// <param name="parentUUID">The UUID of the parent group for the new group. If null, the root group will be used.</param>
[JsonRpcMethod]
public Group AddGroup(string name, string parentUUID)
{
// Make sure there is an active database
if (!EnsureDBisOpen()) return null;
PwGroup newGroup = new PwGroup(true, true);
newGroup.Name = name;
PwGroup parentGroup = GetRootPwGroup(_host.Database); // if in doubt we'll stick it in the root folder
if (parentUUID != null && parentUUID.Length > 0)
{
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(parentUUID));
PwGroup matchedGroup = _host.Database.RootGroup.FindGroup(pwuuid, true);
if (matchedGroup != null)
parentGroup = matchedGroup;
}
parentGroup.AddGroup(newGroup, true);
_host.MainWindow.BeginInvoke(new dlgSaveDB(saveDB), _host.Database);
Group output = GetGroupFromPwGroup(newGroup);
return output;
}
/// <summary>
/// Updates an existing login
/// </summary>
/// <param name="login">A login that contains data to be copied into the existing login</param>
/// <param name="oldLoginUUID">The UUID that identifies the login we want to update</param>
/// <param name="urlMergeMode">1= Replace the entry's URL (but still fill forms if you visit the old URL)
///2= Replace the entry's URL (delete the old URL completely)
///3= Keep the old entry's URL (but still fill forms if you visit the new URL)
///4= Keep the old entry's URL (don't add the new URL to the entry)
///5= No merge. Delete all URLs and replace with those supplied in the new entry data</param>
/// <param name="dbFileName">Database that contains the login to update</param>
/// <returns>The updated login</returns>
[JsonRpcMethod]
public Entry UpdateLogin(Entry login, string oldLoginUUID, int urlMergeMode, string dbFileName)
{
if (login == null)
throw new ArgumentException("(new) login was not passed to the updateLogin function");
if (string.IsNullOrEmpty(oldLoginUUID))
throw new ArgumentException("oldLoginUUID was not passed to the updateLogin function");
if (string.IsNullOrEmpty(dbFileName))
throw new ArgumentException("dbFileName was not passed to the updateLogin function");
// Make sure there is an active database
if (!EnsureDBisOpen()) return null;
// There are odd bits of the resulting new login that we don't
// need but the vast majority is going to be useful
PwEntry newLoginData = new PwEntry(true, true);
setPwEntryFromEntry(newLoginData, login);
// find the database
PwDatabase chosenDB = SelectDatabase(dbFileName);
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(oldLoginUUID));
PwEntry entryToUpdate = GetRootPwGroup(chosenDB).FindEntry(pwuuid, true);
if (entryToUpdate == null)
throw new Exception("oldLoginUUID could not be resolved to an existing entry.");
MergeEntries(entryToUpdate, newLoginData, urlMergeMode, chosenDB);
_host.MainWindow.BeginInvoke(new dlgSaveDB(saveDB), chosenDB);
Entry updatedEntry = (Entry)GetEntryFromPwEntry(entryToUpdate, MatchAccuracy.Best, true, chosenDB);
return updatedEntry;
}
/// <summary>
/// Return the parent group of the object with the supplied UUID
/// </summary>
/// <param name="uuid">the UUID of the object we want to find the parent of</param>
/// <returns>the parent group</returns>
[JsonRpcMethod]
public Group GetParent(string uuid)
{
Group output;
// Make sure there is an active database
if (!EnsureDBisOpen()) return null;
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(uuid));
PwGroup rootGroup = GetRootPwGroup(_host.Database);
try
{
PwEntry thisEntry = rootGroup.FindEntry(pwuuid, true);
if (thisEntry != null && thisEntry.ParentGroup != null)
{
output = GetGroupFromPwGroup(thisEntry.ParentGroup);
return output;
}
PwGroup thisGroup = rootGroup.FindGroup(pwuuid, true);
if (thisGroup != null && thisGroup.ParentGroup != null)
{
output = GetGroupFromPwGroup(thisGroup.ParentGroup);
return output;
}
}
catch (Exception)
{
return null;
}
output = GetGroupFromPwGroup(rootGroup);
return output;
}
/// <summary>
/// Return the root group of the active database
/// </summary>
/// <returns>the root group</returns>
[JsonRpcMethod]
public Group GetRoot()
{
return GetGroupFromPwGroup(GetRootPwGroup(_host.Database));
}
[JsonRpcMethod]
public Database[] GetAllDatabases(bool fullDetails)
{
Debug.Indent();
Stopwatch sw = Stopwatch.StartNew();
List<PwDatabase> dbs = _host.MainWindow.DocumentManager.GetOpenDatabases();
// unless the DB is the wrong version
dbs = dbs.FindAll(ConfigIsCorrectVersion);
List<Database> output = new List<Database>(1);
foreach (PwDatabase db in dbs)
{
var dto = GetDatabaseFromPwDatabase(db, fullDetails, false);
if (dto != null)
{
output.Add(dto);
}
}
Database[] dbarray = output.ToArray();
sw.Stop();
Debug.WriteLine("GetAllDatabases execution time: " + sw.Elapsed);
Debug.Unindent();
return dbarray;
}
/// <summary>
/// Return a list of every entry in the database that has a URL
/// </summary>
/// <returns>all logins in the database that have a URL</returns>
[JsonRpcMethod]
public Entry[] GetEntries()
{
return getAllLogins(true);
}
/// <summary>
/// Return a list of every entry in the database that has a URL
/// </summary>
/// <returns>all logins in the database that have a URL</returns>
/// <remarks>GetAllLogins is deprecated. Use GetEntries instead.</remarks>
[JsonRpcMethod]
public Entry[] GetAllLogins()
{
return getAllLogins(true);
}
/// <summary>
/// Return a list of every entry in the database - this includes entries without an URL
/// </summary>
/// <returns>all logins in the database</returns>
[JsonRpcMethod]
public Entry[] GetAllEntries()
{
return getAllLogins(false);
}
/// <summary>
/// Returns a list of every entry contained within a group (not recursive)
/// </summary>
/// <param name="uuid">the unique ID of the group we're interested in.</param>
/// <returns>the list of every entry with a URL directly inside the group.</returns>
[JsonRpcMethod]
public Entry[] GetChildEntries(string uuid)
{
PwGroup matchedGroup;
matchedGroup = findMatchingGroup(uuid);
return (Entry[])GetChildEntries(_host.Database, matchedGroup, true, true);
}
/// <summary>
/// Returns a list of all the entry contained within a group - including ones missing a URL (not recursive)
/// </summary>
/// <param name="uuid">the unique ID of the group we're interested in.</param>
/// <returns>the list of every entry directly inside the group.</returns>
[JsonRpcMethod]
public Entry[] GetAllChildEntries(string uuid)
{
PwGroup matchedGroup;
matchedGroup = findMatchingGroup(uuid);
return (Entry[])GetChildEntries(_host.Database, matchedGroup, true, false);
}
/// <summary>
/// Returns a list of every group contained within a group (not recursive)
/// </summary>
/// <param name="uuid">the unique ID of the group we're interested in.</param>
/// <returns>the list of every group directly inside the group.</returns>
[JsonRpcMethod]
public Group[] GetChildGroups(string uuid)
{
PwGroup matchedGroup;
matchedGroup = findMatchingGroup(uuid);
return GetChildGroups(_host.Database, matchedGroup, false, true);
}
/// <summary>
/// Return a list of groups. If uuid is supplied, the list will have a maximum of one entry. Otherwise it could have any number. TODO2: KeePass doesn't have an easy way to search groups by name so postponing that functionality until really needed (or implemented by KeePass API anyway) - for now, name IS COMPLETELY IGNORED
/// </summary>
/// <param name="name">IGNORED! The name of a groups we are looking for. Must be an exact match.</param>
/// <param name="uuid">The UUID of the group we are looking for.</param>
/// <param name="groups">The output result (a list of Groups)</param>
/// <returns>The number of items in the list of groups.</returns>
[JsonRpcMethod]
public int FindGroups(string name, string uuid, out Group[] groups)
{
// if uniqueID is supplied, match just that one group. if not found, move on to search the content of the logins...
if (uuid != null && uuid.Length > 0)
{
// Make sure there is an active database
if (!EnsureDBisOpen())
{
groups = null;
return -1;
}
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(uuid));
PwGroup matchedGroup = _host.Database.RootGroup.FindGroup(pwuuid, true);
if (matchedGroup == null)
throw new Exception(
"Could not find requested group. Have you deleted your Kee home group? Set a new one and try again.");
groups = new Group[1];
groups[0] = GetGroupFromPwGroup(matchedGroup);
if (groups[0] != null)
return 1;
}
groups = null;
return 0;
}
/// <summary>
/// Finds entries. Presence of certain parameters dictates type of search performed in the following priority order: uniqueId; freeTextSearch; URL, realm, etc.. Searching stops as soon as one of the different types of search results in a successful match. Supply a username to limit results from URL and realm searches (to search for username regardless of URL/realm, do a free text search and filter results in your client).
/// </summary>
/// <param name="unsanitisedURLs">The URLs to search for. Host must be lower case as per the URI specs. Other parts are case sensitive.</param>
/// <param name="actionURL">The action URL.</param>
/// <param name="httpRealm">The HTTP realm.</param>
/// <param name="lst">The type of login search to perform. E.g. look for form matches or HTTP Auth matches.</param>
/// <param name="requireFullURLMatches">if set to <c>true</c> require full URL matches - host name match only is unacceptable.</param>
/// <param name="uniqueID">The unique ID of a particular entry we want to retrieve.</param>
/// <param name="dbRootID">The unique ID of the root group of the database we want to search. Empty string = search all DBs</param>
/// <param name="freeTextSearch">A string to search for in all entries. E.g. title, username (may change)</param>
/// /// <param name="username">Limit a search for URL to exact username matches only</param>
/// <returns>An entry suitable for use by a JSON-RPC client.</returns>
[JsonRpcMethod]
public Entry[] FindLogins(string[] unsanitisedURLs, string actionURL,
string httpRealm, LoginSearchType lst, bool requireFullURLMatches,
string uniqueID, string dbFileName, string freeTextSearch, string username)
{
List<PwDatabase> dbs = null;
int count = 0;
List<Entry> allEntries = new List<Entry>();
if (!string.IsNullOrEmpty(dbFileName))
{
// find the database
PwDatabase db = SelectDatabase(dbFileName);
dbs = new List<PwDatabase>();
dbs.Add(db);
}
else
{
// if DB list is not populated, look in all open DBs
dbs = _host.MainWindow.DocumentManager.GetOpenDatabases();
// unless the DB is the wrong version
dbs = dbs.FindAll(ConfigIsCorrectVersion);
}
// Make sure there is an active database
if (!EnsureDBisOpen())
{
return null;
}
// if uniqueID is supplied, match just that one login. if not found, move on to search the content of the logins...
if (uniqueID != null && uniqueID.Length > 0)
{
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(uniqueID));
//foreach DB...
foreach (PwDatabase db in dbs)
{
PwEntry matchedLogin = GetRootPwGroup(db).FindEntry(pwuuid, true);
if (matchedLogin == null)
continue;
Entry[] logins = new Entry[1];
logins[0] = (Entry)GetEntryFromPwEntry(matchedLogin, MatchAccuracy.Best, true, db);
if (logins[0] != null)
return logins;
}
}
if (!string.IsNullOrEmpty(freeTextSearch))
{
foreach (PwDatabase db in dbs)
{
PwObjectList<PwEntry> output =
new PwObjectList<PwEntry>();
PwGroup searchGroup = GetRootPwGroup(db);
SearchParameters sp = new SearchParameters();
sp.ComparisonMode = StringComparison.InvariantCultureIgnoreCase;
sp.SearchString = freeTextSearch;
sp.SearchInUserNames = true;
sp.SearchInTitles = true;
sp.SearchInTags = true;
searchGroup.SearchEntries(sp, output);
foreach (PwEntry pwe in output)
{
Entry kpe = (Entry)GetEntryFromPwEntry(pwe, MatchAccuracy.None, true, db);
if (kpe != null)
{
allEntries.Add(kpe);
count++;
}
}
}
}
// else we search for the URLs
// First, we remove any data URIs from the list - there aren't any practical use cases
// for this which can trump the security risks introduced by attempting to support their use.
var santisedURLs = new List<string>(unsanitisedURLs);
santisedURLs.RemoveAll(u => u.StartsWith("data:"));
var URLs = santisedURLs.ToArray();
if (count == 0 && URLs.Length > 0 && !string.IsNullOrEmpty(URLs[0]))
{
Dictionary<string, URLSummary> URLHostnameAndPorts = new Dictionary<string, URLSummary>();
// make sure that hostname and actionURL always represent only the hostname portion
// of the URL
// It's tempting to demand that the protocol must match too (e.g. http forms won't
// match a stored https login) but best not to define such a restriction in KeePassRPC
// - the RPC client (e.g. KeeFox) can decide to penalise protocol mismatches,
// potentially dependant on user configuration options in the client.
for (int i = 0; i < URLs.Length; i++)
{
URLHostnameAndPorts.Add(URLs[i], URLSummary.FromURL(URLs[i]));
}
foreach (PwDatabase db in dbs)
{
var dbConf = db.GetKPRPCConfig();
PwObjectList<PwEntry> output =
new PwObjectList<PwEntry>();
PwGroup searchGroup = GetRootPwGroup(db);
output = searchGroup.GetEntries(true);
List<string> configErrors = new List<string>(1);
// Search every entry in the DB
foreach (PwEntry pwe in output)
{
string entryUserName = pwe.Strings.ReadSafe(PwDefs.UserNameField);
entryUserName =
_keePassRpcPlugin.GetPwEntryStringFromDereferencableValue(pwe, entryUserName, db);
if (EntryIsInRecycleBin(pwe, db))
continue; // ignore if it's in the recycle bin
EntryConfigv2 conf =
pwe.GetKPRPCConfigNormalised(null, ref configErrors, dbConf.DefaultMatchAccuracy);
if (conf == null || conf.MatcherConfigs.Any(mc => mc.MatcherType == EntryMatcherType.Hide))
continue;
var urlMatcher =
conf.MatcherConfigs.FirstOrDefault(mc => mc.MatcherType == EntryMatcherType.Url);
if (urlMatcher == null)
{
// Ignore entries with no Url matcher type. Shouldn't ever happen but maybe loading a newer
// DB into an old version will cause it so this just protects us against unexpected matches
// in case of that user error.
continue;
}
bool entryIsAMatch = false;
int bestMatchAccuracy = MatchAccuracy.None;
if (conf.RegExUrls != null)
foreach (string url in URLs)
foreach (string regexPattern in conf.RegExUrls)
{
try
{
if (!string.IsNullOrEmpty(regexPattern) &&
Regex.IsMatch(url, regexPattern))
{
entryIsAMatch = true;
bestMatchAccuracy = MatchAccuracy.Best;
break;
}
}
catch (ArgumentException)
{
Utils.ShowMonoSafeMessageBox(
"'" + regexPattern +
"' is not a valid regular expression. This error was found in an entry in your database called '" +
pwe.Strings.ReadSafe(PwDefs.TitleField) +
"'. You need to fix or delete this regular expression to prevent this warning message appearing.",
"Warning: Broken regular expression", MessageBoxButtons.OK,
MessageBoxIcon.Warning);
break;
}
}
if (!entryIsAMatch && (string.IsNullOrEmpty(username) || username == entryUserName))
{
foreach (string URL in URLs)
{
var mam = pwe.GetMatchAccuracyMethod(URLHostnameAndPorts[URL], dbConf);
int accuracy =
BestMatchAccuracyForAnyURL(pwe, conf, URL, URLHostnameAndPorts[URL], mam);
if (accuracy > bestMatchAccuracy)
bestMatchAccuracy = accuracy;
}
}
if (bestMatchAccuracy == MatchAccuracy.Best
|| (!requireFullURLMatches && bestMatchAccuracy > MatchAccuracy.None))
entryIsAMatch = true;
foreach (string URL in URLs)
{
// If we think we found a match, check it's not on a block list
if (entryIsAMatch && matchesAnyBlockedURL(pwe, conf, URL))
{
entryIsAMatch = false;
break;
}
if (conf.RegExBlockedUrls != null)
foreach (string pattern in conf.RegExBlockedUrls)
{
try
{
if (!string.IsNullOrEmpty(pattern) &&
Regex.IsMatch(URL, pattern))
{
entryIsAMatch = false;
break;
}
}
catch (ArgumentException)
{
Utils.ShowMonoSafeMessageBox(
"'" + pattern +
"' is not a valid regular expression. This error was found in an entry in your database called '" +
pwe.Strings.ReadSafe(PwDefs.TitleField) +
"'. You need to fix or delete this regular expression to prevent this warning message appearing.",
"Warning: Broken regular expression", MessageBoxButtons.OK,
MessageBoxIcon.Warning);
break;
}
}
}
if (entryIsAMatch)
{
Entry kpe = (Entry)GetEntryFromPwEntry(pwe, bestMatchAccuracy, true, db);
if (kpe != null)
{
allEntries.Add(kpe);
count++;
}
}
}
if (configErrors.Count > 0)
Utils.ShowMonoSafeMessageBox(
"There are configuration errors in your database called '" + db.Name +
"'. To fix the entries listed below and prevent this warning message appearing, please edit the value of the 'KeePassRPC JSON' custom data. Please ask for help on https://forum.kee.pm if you're not sure how to fix this. These entries are affected:" +
Environment.NewLine + string.Join(Environment.NewLine, configErrors.ToArray()),
"Warning: Configuration errors", MessageBoxButtons.OK, MessageBoxIcon.Warning);
}
}
allEntries.Sort(delegate(Entry e1, Entry e2) { return e1.Title.CompareTo(e2.Title); });
return allEntries.ToArray();
}
#endregion
#region V2 Retrival and manipulation of entries and groups
/// <summary>
/// Add a new entry to the active KeePass database
/// </summary>
/// <param name="entry">The KeePassRPC representation of the entry to be added</param>
/// <param name="parentUuid">The UUID of the parent group for the new entry. If null, the root group will be used.</param>
/// <param name="dbFileName">The file name of the database we want to save this entry to;
/// if empty or null, the currently active database is used</param>
/// <returns>The new entry, after having passed through the conversion to and from a KeePass Entry</returns>
[JsonRpcMethod]
public Entry2 AddEntry(Entry2 entry, string parentUuid, string dbFileName)
{
if (ClientMetadata == null || ClientMetadata.Features == null ||
!ClientMetadata.Features.Contains("KPRPC_FEATURE_DTO_V2"))
{
throw new Exception("Client feature missing: KPRPC_FEATURE_DTO_V2");
}
// Make sure there is an active database
if (!EnsureDBisOpen()) return null;
PwEntry newLogin = new PwEntry(true, true);
setPwEntryFromEntry2(newLogin, entry);
// find the database
PwDatabase chosenDb = SelectDatabase(dbFileName);
PwGroup parentGroup = GetRootPwGroup(chosenDb); // if in doubt we'll stick it in the root folder
if (!string.IsNullOrEmpty(parentUuid))
{
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(parentUuid));
PwGroup matchedGroup = GetRootPwGroup(chosenDb).FindGroup(pwuuid, true);
if (matchedGroup != null)
parentGroup = matchedGroup;
}
parentGroup.AddEntry(newLogin, true);
if (_host.CustomConfig.GetBool("KeePassRPC.KeeFox.editNewEntries", false))
_host.MainWindow.BeginInvoke(new dlgOpenLoginEditorWindow(OpenLoginEditorWindow), newLogin, chosenDb);
else
_host.MainWindow.BeginInvoke(new dlgSaveDB(saveDB), chosenDb);
return (Entry2)GetEntry2FromPwEntry(newLogin, MatchAccuracy.Best, true, chosenDb, true);
}
/// <summary>
/// Updates an existing entry
/// </summary>
/// <param name="entry">A entry that contains data to be copied into the existing entry</param>
/// <param name="oldLoginUuid">The UUID that identifies the entry we want to update</param>
/// <param name="urlMergeMode">1= Replace the entry's URL (but still fill forms if you visit the old URL)
///2= Replace the entry's URL (delete the old URL completely)
///3= Keep the old entry's URL (but still fill forms if you visit the new URL)
///4= Keep the old entry's URL (don't add the new URL to the entry)
///5= No merge. Delete all URLs and replace with those supplied in the new entry data</param>
/// <param name="dbFileName">Database that contains the entry to update</param>
/// <returns>The updated entry, after having passed through the conversion to and from a KeePass Entry</returns>
[JsonRpcMethod]
public Entry2 UpdateEntry(Entry2 entry, string oldLoginUuid, int urlMergeMode, string dbFileName)
{
if (ClientMetadata == null || ClientMetadata.Features == null ||
!ClientMetadata.Features.Contains("KPRPC_FEATURE_DTO_V2"))
{
throw new Exception("Client feature missing: KPRPC_FEATURE_DTO_V2");
}
if (entry == null)
throw new ArgumentException("(new) entry was not passed to the updateEntry function");
if (string.IsNullOrEmpty(oldLoginUuid))
throw new ArgumentException("oldLoginUUID was not passed to the updateEntry function");
if (string.IsNullOrEmpty(dbFileName))
throw new ArgumentException("dbFileName was not passed to the updateEntry function");
// Make sure there is an active database
if (!EnsureDBisOpen()) return null;
// There are odd bits of the resulting new entry that we don't
// need but the vast majority is going to be useful
PwEntry newPwEntryData = new PwEntry(true, true);
setPwEntryFromEntry2(newPwEntryData, entry);
// find the database
PwDatabase chosenDb = SelectDatabase(dbFileName);
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(oldLoginUuid));
PwEntry entryToUpdate = GetRootPwGroup(chosenDb).FindEntry(pwuuid, true);
if (entryToUpdate == null)
throw new Exception("oldLoginUUID could not be resolved to an existing entry.");
MergeEntries(entryToUpdate, newPwEntryData, urlMergeMode, chosenDb);
_host.MainWindow.BeginInvoke(new dlgSaveDB(saveDB), chosenDb);
return (Entry2)GetEntry2FromPwEntry(entryToUpdate, MatchAccuracy.Best, true, chosenDb, true);
}
[JsonRpcMethod]
public DatabaseAndIcons[] AllDatabasesAndIcons(bool fullDetails)
{
if (ClientMetadata == null || ClientMetadata.Features == null ||
!ClientMetadata.Features.Contains("KPRPC_FEATURE_DTO_V2"))
{
throw new Exception("Client feature missing: KPRPC_FEATURE_DTO_V2");
}
if (ClientMetadata == null || ClientMetadata.Features == null ||
!ClientMetadata.Features.Contains("KPRPC_FEATURE_ICON_REFERENCES"))
{
throw new Exception("Client feature missing: KPRPC_FEATURE_ICON_REFERENCES");
}
var dis = new List<DatabaseAndIcons>();
var dbs = AllDatabases(fullDetails);
foreach (var db in dbs)
{
var iconCollection = AllIcons(db.FileName);
dis.Add(new DatabaseAndIcons
{
Database = db,
Icons = iconCollection
});
}
return dis.ToArray();
}
[JsonRpcMethod]
public IconCollection AllIcons(string dbFileName)
{
if (ClientMetadata == null || ClientMetadata.Features == null ||
!ClientMetadata.Features.Contains("KPRPC_FEATURE_DTO_V2"))
{
throw new Exception("Client feature missing: KPRPC_FEATURE_DTO_V2");
}
if (ClientMetadata == null || ClientMetadata.Features == null ||
!ClientMetadata.Features.Contains("KPRPC_FEATURE_ICON_REFERENCES"))
{
throw new Exception("Client feature missing: KPRPC_FEATURE_ICON_REFERENCES");
}
var database = _host.MainWindow.DocumentManager.GetOpenDatabases()
.Single(db => db.IOConnectionInfo.Path == dbFileName);
var customIcons = new List<IconData>(database.CustomIcons.Count);
foreach (var ci in database.CustomIcons)
{
customIcons.Add(new IconData
{
Id = ci.Uuid.ToHexString(),
Icon = _iconConverter.iconToBase64(ci.Uuid, PwIcon.Key)
});
}
var standardIcons = _iconConverter.Base64StandardIconsUnknownToClient(ClientMetadata);
return new IconCollection
{
DatabaseIcon = IconCache<string>.GetIconEncoding(database.IOConnectionInfo.Path) ?? "",
DatabaseFilename = database.IOConnectionInfo.Path,
CustomIcons = customIcons.ToArray(),
StandardIcons = standardIcons
};
}
[JsonRpcMethod]
public Database2[] AllDatabases(bool fullDetails)
{
if (ClientMetadata == null || ClientMetadata.Features == null ||
!ClientMetadata.Features.Contains("KPRPC_FEATURE_DTO_V2"))
{
throw new Exception("Client feature missing: KPRPC_FEATURE_DTO_V2");
}
Debug.Indent();
Stopwatch sw = Stopwatch.StartNew();
List<PwDatabase> dbs = _host.MainWindow.DocumentManager.GetOpenDatabases();
// unless the DB is the wrong version
dbs = dbs.FindAll(ConfigIsCorrectVersion);
List<Database2> output = new List<Database2>(5);
foreach (PwDatabase db in dbs)
{
var dto = GetDatabase2FromPwDatabase(db, fullDetails, false, true);
if (dto != null)
{
output.Add(dto);
}
}
Database2[] dbarray = output.ToArray();
sw.Stop();
Debug.WriteLine("AllDatabases execution time: " + sw.Elapsed);
Debug.Unindent();
return dbarray;
}
/// <summary>
/// Finds entries. Presence of certain parameters dictates type of search performed in the following priority order: uniqueId; freeTextSearch; URL, etc.. Searching stops as soon as one of the different types of search results in a successful match. Supply a username to limit results from URL searches (to search for username regardless of URL, do a free text search and filter results in your client).
/// </summary>
/// <param name="unsanitisedUrls">The URLs to search for. Host must be lower case as per the URI specs. Other parts are case sensitive.</param>
/// <param name="requireFullUrlMatches">if set to <c>true</c> require full URL matches - host name match only is unacceptable.</param>
/// <param name="uuid">The unique ID of a particular entry we want to retrieve.</param>
/// <param name="dbFileName">The file name of the database we want to search. Empty string = search all DBs</param>
/// <param name="freeTextSearch">A string to search for in all entries. E.g. title, username (may change)</param>
/// <param name="username">Limit a search for URL to exact username matches only</param>
/// <returns>A list of entries suitable for use by a JSON-RPC client.</returns>
[JsonRpcMethod]
public Entry2[] FindEntries(string[] unsanitisedUrls, bool requireFullUrlMatches,
string uuid, string dbFileName, string freeTextSearch, string username)
{
if (ClientMetadata == null || ClientMetadata.Features == null ||
!ClientMetadata.Features.Contains("KPRPC_FEATURE_DTO_V2"))
{
throw new Exception("Client feature missing: KPRPC_FEATURE_DTO_V2");
}
List<PwDatabase> dbs = null;
int count = 0;
List<Entry2> allEntries = new List<Entry2>();
if (!string.IsNullOrEmpty(dbFileName))
{
// find the database
PwDatabase db = SelectDatabase(dbFileName);
dbs = new List<PwDatabase>();
dbs.Add(db);
}
else
{
// if DB list is not populated, look in all open DBs
dbs = _host.MainWindow.DocumentManager.GetOpenDatabases();
// unless the DB is the wrong version
dbs = dbs.FindAll(ConfigIsCorrectVersion);
}
// Make sure there is an active database
if (!EnsureDBisOpen())
{
return null;
}
// if uniqueID is supplied, match just that one login. if not found, move on to search the content of the logins...
if (!string.IsNullOrEmpty(uuid))
{
PwUuid pwuuid = new PwUuid(MemUtil.HexStringToByteArray(uuid));
foreach (PwDatabase db in dbs)
{
PwEntry matchedLogin = GetRootPwGroup(db).FindEntry(pwuuid, true);
if (matchedLogin == null)
continue;
var logins = new Entry2[1];
logins[0] = (Entry2)GetEntry2FromPwEntry(matchedLogin, MatchAccuracy.Best, true, db, true);
if (logins[0] != null)
return logins;
}
}
if (!string.IsNullOrEmpty(freeTextSearch))
{
foreach (PwDatabase db in dbs)
{
PwObjectList<PwEntry> output =
new PwObjectList<PwEntry>();
PwGroup searchGroup = GetRootPwGroup(db);
SearchParameters sp = new SearchParameters();
sp.ComparisonMode = StringComparison.InvariantCultureIgnoreCase;
sp.SearchString = freeTextSearch;
sp.SearchInUserNames = true;
sp.SearchInTitles = true;
sp.SearchInTags = true;
searchGroup.SearchEntries(sp, output);
foreach (PwEntry pwe in output)
{
Entry2 kpe = (Entry2)GetEntry2FromPwEntry(pwe, MatchAccuracy.None, true, db, true);
if (kpe != null)
{
allEntries.Add(kpe);
count++;
}
}
}
}
// else we search for the URLs
// First, we remove any data URIs from the list - there aren't any practical use cases
// for this which can trump the security risks introduced by attempting to support their use.
var santisedUrls = new List<string>(unsanitisedUrls);
santisedUrls.RemoveAll(u => u.StartsWith("data:"));
var urls = santisedUrls.ToArray();
if (count == 0 && urls.Length > 0 && !string.IsNullOrEmpty(urls[0]))
{
Dictionary<string, URLSummary> urlHostnameAndPorts = new Dictionary<string, URLSummary>();
// make sure that hostname and actionURL always represent only the hostname portion
// of the URL
// It's tempting to demand that the protocol must match too (e.g. http forms won't
// match a stored https login) but best not to define such a restriction in KeePassRPC
// - the RPC client (e.g. KeeFox) can decide to penalise protocol mismatches,
// potentially dependant on user configuration options in the client.
for (int i = 0; i < urls.Length; i++)
{
urlHostnameAndPorts.Add(urls[i], URLSummary.FromURL(urls[i]));
}
foreach (PwDatabase db in dbs)
{
var dbConf = db.GetKPRPCConfig();
PwObjectList<PwEntry> output =
new PwObjectList<PwEntry>();
PwGroup searchGroup = GetRootPwGroup(db);
output = searchGroup.GetEntries(true);
List<string> configErrors = new List<string>(1);
// Search every entry in the DB
foreach (PwEntry pwe in output)
{
string entryUserName = pwe.Strings.ReadSafe(PwDefs.UserNameField);
entryUserName =
_keePassRpcPlugin.GetPwEntryStringFromDereferencableValue(pwe, entryUserName, db);
if (EntryIsInRecycleBin(pwe, db))
continue; // ignore if it's in the recycle bin
EntryConfigv2 conf =
pwe.GetKPRPCConfigNormalised(null, ref configErrors, dbConf.DefaultMatchAccuracy);
if (conf == null || conf.MatcherConfigs.Any(mc => mc.MatcherType == EntryMatcherType.Hide))
continue;
var urlMatcher =
conf.MatcherConfigs.FirstOrDefault(mc => mc.MatcherType == EntryMatcherType.Url);
if (urlMatcher == null)
{
// Ignore entries with no Url matcher type. Shouldn't ever happen but maybe loading a newer DB
// into an old version will cause it so this just protects us against unexpected matches in
// case of that user error.
continue;
}
bool entryIsAMatch = false;
int bestMatchAccuracy = MatchAccuracy.None;
if (conf.RegExUrls != null)
foreach (string url in urls)
foreach (string regexPattern in conf.RegExUrls)
{
try
{
if (!string.IsNullOrEmpty(regexPattern) &&
Regex.IsMatch(url, regexPattern))
{
entryIsAMatch = true;
bestMatchAccuracy = MatchAccuracy.Best;
break;
}
}
catch (ArgumentException)
{
Utils.ShowMonoSafeMessageBox(
"'" + regexPattern +
"' is not a valid regular expression. This error was found in an entry in your database called '" +
pwe.Strings.ReadSafe(PwDefs.TitleField) +
"'. You need to fix or delete this regular expression to prevent this warning message appearing.",
"Warning: Broken regular expression", MessageBoxButtons.OK,
MessageBoxIcon.Warning);
break;
}
}
if (!entryIsAMatch && (string.IsNullOrEmpty(username) || username == entryUserName))
{
foreach (string url in urls)
{
var mam = pwe.GetMatchAccuracyMethod(urlHostnameAndPorts[url], dbConf);
int accuracy =
BestMatchAccuracyForAnyURL(pwe, conf, url, urlHostnameAndPorts[url], mam);
if (accuracy > bestMatchAccuracy)
bestMatchAccuracy = accuracy;
}
}
if (bestMatchAccuracy == MatchAccuracy.Best
|| (!requireFullUrlMatches && bestMatchAccuracy > MatchAccuracy.None))
entryIsAMatch = true;
foreach (string url in urls)
{
// If we think we found a match, check it's not on a block list
if (entryIsAMatch && matchesAnyBlockedURL(pwe, conf, url))
{
entryIsAMatch = false;
break;
}
if (conf.RegExBlockedUrls != null)
foreach (string pattern in conf.RegExBlockedUrls)
{
try
{
if (!string.IsNullOrEmpty(pattern) &&
Regex.IsMatch(url, pattern))
{
entryIsAMatch = false;
break;
}
}
catch (ArgumentException)
{
Utils.ShowMonoSafeMessageBox(
"'" + pattern +
"' is not a valid regular expression. This error was found in an entry in your database called '" +
pwe.Strings.ReadSafe(PwDefs.TitleField) +
"'. You need to fix or delete this regular expression to prevent this warning message appearing.",
"Warning: Broken regular expression", MessageBoxButtons.OK,
MessageBoxIcon.Warning);
break;
}
}
}
if (entryIsAMatch)
{
Entry2 kpe = (Entry2)GetEntry2FromPwEntry(pwe, bestMatchAccuracy, true, db, true);
if (kpe != null)
{
allEntries.Add(kpe);
count++;
}
}
}
if (configErrors.Count > 0)
Utils.ShowMonoSafeMessageBox(
"There are configuration errors in your database called '" + db.Name +
"'. To fix the entries listed below and prevent this warning message appearing, please edit the value of the 'KeePassRPC JSON' custom data. Please ask for help on https://forum.kee.pm if you're not sure how to fix this. These entries are affected:" +
Environment.NewLine + string.Join(Environment.NewLine, configErrors.ToArray()),
"Warning: Configuration errors", MessageBoxButtons.OK, MessageBoxIcon.Warning);
}
}
allEntries.Sort(delegate(Entry2 e1, Entry2 e2) { return e1.Title.CompareTo(e2.Title); });
return allEntries.ToArray();
}
#endregion
}
}
|