TestKdbx4.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606
  1. /*
  2. * Copyright (C) 2018 KeePassXC Team <team@keepassxc.org>
  3. *
  4. * This program is free software: you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License as published by
  6. * the Free Software Foundation, either version 2 or (at your option)
  7. * version 3 of the License.
  8. *
  9. * This program is distributed in the hope that it will be useful,
  10. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. * GNU General Public License for more details.
  13. *
  14. * You should have received a copy of the GNU General Public License
  15. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  16. */
  17. #include "TestKdbx4.h"
  18. #include "config-keepassx-tests.h"
  19. #include "core/Metadata.h"
  20. #include "format/KdbxXmlReader.h"
  21. #include "format/KdbxXmlWriter.h"
  22. #include "format/KeePass2.h"
  23. #include "format/KeePass2Reader.h"
  24. #include "format/KeePass2Writer.h"
  25. #ifdef WITH_XC_KEESHARE
  26. #include "keeshare/KeeShare.h"
  27. #include "keeshare/KeeShareSettings.h"
  28. #endif
  29. #include "keys/FileKey.h"
  30. #include "keys/PasswordKey.h"
  31. #include "mock/MockChallengeResponseKey.h"
  32. #include <QTest>
  33. int main(int argc, char* argv[])
  34. {
  35. QCoreApplication app(argc, argv);
  36. QCoreApplication::setAttribute(Qt::AA_Use96Dpi, true);
  37. QTEST_SET_MAIN_SOURCE_PATH
  38. TestKdbx4Argon2 argon2Test;
  39. TestKdbx4AesKdf aesKdfTest;
  40. TestKdbx4Format kdbx4Test;
  41. return QTest::qExec(&argon2Test, argc, argv) || QTest::qExec(&aesKdfTest, argc, argv)
  42. || QTest::qExec(&kdbx4Test, argc, argv);
  43. }
  44. void TestKdbx4Argon2::initTestCaseImpl()
  45. {
  46. m_xmlDb->changeKdf(fastKdf(KeePass2::uuidToKdf(KeePass2::KDF_ARGON2D)));
  47. m_kdbxSourceDb->changeKdf(fastKdf(KeePass2::uuidToKdf(KeePass2::KDF_ARGON2D)));
  48. }
  49. QSharedPointer<Database>
  50. TestKdbx4Argon2::readXml(const QString& path, bool strictMode, bool& hasError, QString& errorString)
  51. {
  52. KdbxXmlReader reader(KeePass2::FILE_VERSION_4);
  53. reader.setStrictMode(strictMode);
  54. auto db = reader.readDatabase(path);
  55. hasError = reader.hasError();
  56. errorString = reader.errorString();
  57. return db;
  58. }
  59. QSharedPointer<Database> TestKdbx4Argon2::readXml(QBuffer* buf, bool strictMode, bool& hasError, QString& errorString)
  60. {
  61. KdbxXmlReader reader(KeePass2::FILE_VERSION_4);
  62. reader.setStrictMode(strictMode);
  63. auto db = reader.readDatabase(buf);
  64. hasError = reader.hasError();
  65. errorString = reader.errorString();
  66. return db;
  67. }
  68. void TestKdbx4Argon2::writeXml(QBuffer* buf, Database* db, bool& hasError, QString& errorString)
  69. {
  70. KdbxXmlWriter writer(KeePass2::FILE_VERSION_4, {});
  71. writer.writeDatabase(buf, db);
  72. hasError = writer.hasError();
  73. errorString = writer.errorString();
  74. }
  75. void TestKdbx4Argon2::readKdbx(QIODevice* device,
  76. QSharedPointer<const CompositeKey> key,
  77. QSharedPointer<Database> db,
  78. bool& hasError,
  79. QString& errorString)
  80. {
  81. KeePass2Reader reader;
  82. reader.readDatabase(device, key, db.data());
  83. hasError = reader.hasError();
  84. if (hasError) {
  85. errorString = reader.errorString();
  86. }
  87. QCOMPARE(reader.version(), KeePass2::FILE_VERSION_4);
  88. }
  89. void TestKdbx4Argon2::writeKdbx(QIODevice* device, Database* db, bool& hasError, QString& errorString)
  90. {
  91. if (db->kdf()->uuid() == KeePass2::KDF_AES_KDBX3) {
  92. db->changeKdf(fastKdf(KeePass2::uuidToKdf(KeePass2::KDF_ARGON2D)));
  93. }
  94. KeePass2Writer writer;
  95. hasError = writer.writeDatabase(device, db);
  96. hasError = writer.hasError();
  97. if (hasError) {
  98. errorString = writer.errorString();
  99. }
  100. QCOMPARE(writer.version(), KeePass2::FILE_VERSION_4);
  101. }
  102. void TestKdbx4AesKdf::initTestCaseImpl()
  103. {
  104. m_xmlDb->changeKdf(fastKdf(KeePass2::uuidToKdf(KeePass2::KDF_AES_KDBX4)));
  105. m_kdbxSourceDb->changeKdf(fastKdf(KeePass2::uuidToKdf(KeePass2::KDF_AES_KDBX4)));
  106. }
  107. Q_DECLARE_METATYPE(QUuid)
  108. void TestKdbx4Format::testFormat400()
  109. {
  110. QString filename = QString(KEEPASSX_TEST_DATA_DIR).append("/Format400.kdbx");
  111. auto key = QSharedPointer<CompositeKey>::create();
  112. key->addKey(QSharedPointer<PasswordKey>::create("t"));
  113. KeePass2Reader reader;
  114. auto db = QSharedPointer<Database>::create();
  115. reader.readDatabase(filename, key, db.data());
  116. QCOMPARE(reader.version(), KeePass2::FILE_VERSION_4);
  117. QVERIFY(db.data());
  118. QVERIFY(!reader.hasError());
  119. QCOMPARE(db->rootGroup()->name(), QString("Format400"));
  120. QCOMPARE(db->metadata()->name(), QString("Format400"));
  121. QCOMPARE(db->rootGroup()->entries().size(), 1);
  122. auto entry = db->rootGroup()->entries().at(0);
  123. QCOMPARE(entry->title(), QString("Format400"));
  124. QCOMPARE(entry->username(), QString("Format400"));
  125. QCOMPARE(entry->attributes()->keys().size(), 6);
  126. QCOMPARE(entry->attributes()->value("Format400"), QString("Format400"));
  127. QCOMPARE(entry->attachments()->keys().size(), 1);
  128. QCOMPARE(entry->attachments()->value("Format400"), QByteArray("Format400\n"));
  129. }
  130. void TestKdbx4Format::testFormat400Upgrade()
  131. {
  132. QFETCH(QUuid, kdfUuid);
  133. QFETCH(QUuid, cipherUuid);
  134. QFETCH(bool, addCustomData);
  135. QFETCH(quint32, expectedVersion);
  136. QScopedPointer<Database> sourceDb(new Database());
  137. sourceDb->changeKdf(fastKdf(sourceDb->kdf()));
  138. sourceDb->metadata()->setName("Wubba lubba dub dub");
  139. QCOMPARE(sourceDb->kdf()->uuid(), KeePass2::KDF_AES_KDBX3); // default is legacy AES-KDF
  140. auto key = QSharedPointer<CompositeKey>::create();
  141. key->addKey(QSharedPointer<PasswordKey>::create("I am in great pain, please help me!"));
  142. sourceDb->setKey(key, true, true);
  143. QBuffer buffer;
  144. buffer.open(QBuffer::ReadWrite);
  145. // upgrade to KDBX 4 by changing KDF and Cipher
  146. sourceDb->changeKdf(fastKdf(KeePass2::uuidToKdf(kdfUuid)));
  147. sourceDb->setCipher(cipherUuid);
  148. // CustomData in meta should not cause any version change
  149. sourceDb->metadata()->customData()->set("CustomPublicData", "Hey look, I turned myself into a pickle!");
  150. if (addCustomData) {
  151. // this, however, should
  152. sourceDb->rootGroup()->customData()->set("CustomGroupData",
  153. "I just killed my family! I don't care who they were!");
  154. }
  155. KeePass2Writer writer;
  156. writer.writeDatabase(&buffer, sourceDb.data());
  157. if (writer.hasError()) {
  158. QFAIL(qPrintable(QString("Error while writing database: %1").arg(writer.errorString())));
  159. }
  160. // read buffer back
  161. buffer.seek(0);
  162. KeePass2Reader reader;
  163. auto targetDb = QSharedPointer<Database>::create();
  164. reader.readDatabase(&buffer, key, targetDb.data());
  165. if (reader.hasError()) {
  166. QFAIL(qPrintable(QString("Error while reading database: %1").arg(reader.errorString())));
  167. }
  168. QVERIFY(targetDb->rootGroup());
  169. QCOMPARE(targetDb->metadata()->name(), sourceDb->metadata()->name());
  170. QCOMPARE(reader.version(), expectedVersion);
  171. QCOMPARE(targetDb->cipher(), cipherUuid);
  172. QCOMPARE(targetDb->metadata()->customData()->value("CustomPublicData"),
  173. sourceDb->metadata()->customData()->value("CustomPublicData"));
  174. QCOMPARE(targetDb->rootGroup()->customData()->value("CustomGroupData"),
  175. sourceDb->rootGroup()->customData()->value("CustomGroupData"));
  176. }
  177. // clang-format off
  178. void TestKdbx4Format::testFormat400Upgrade_data()
  179. {
  180. QTest::addColumn<QUuid>("kdfUuid");
  181. QTest::addColumn<QUuid>("cipherUuid");
  182. QTest::addColumn<bool>("addCustomData");
  183. QTest::addColumn<quint32>("expectedVersion");
  184. auto constexpr kdbx3 = KeePass2::FILE_VERSION_3_1;
  185. auto constexpr kdbx4 = KeePass2::FILE_VERSION_4;
  186. QTest::newRow("Argon2d + AES") << KeePass2::KDF_ARGON2D << KeePass2::CIPHER_AES256 << false << kdbx4;
  187. QTest::newRow("Argon2id + AES") << KeePass2::KDF_ARGON2ID << KeePass2::CIPHER_AES256 << false << kdbx4;
  188. QTest::newRow("AES-KDF + AES") << KeePass2::KDF_AES_KDBX4 << KeePass2::CIPHER_AES256 << false << kdbx4;
  189. QTest::newRow("AES-KDF (legacy) + AES") << KeePass2::KDF_AES_KDBX3 << KeePass2::CIPHER_AES256 << false << kdbx3;
  190. QTest::newRow("Argon2d + AES + CustomData") << KeePass2::KDF_ARGON2D << KeePass2::CIPHER_AES256 << true << kdbx4;
  191. QTest::newRow("Argon2id + AES + CustomData") << KeePass2::KDF_ARGON2ID << KeePass2::CIPHER_AES256 << true << kdbx4;
  192. QTest::newRow("AES-KDF + AES + CustomData") << KeePass2::KDF_AES_KDBX4 << KeePass2::CIPHER_AES256 << true << kdbx4;
  193. QTest::newRow("AES-KDF (legacy) + AES + CustomData") << KeePass2::KDF_AES_KDBX3 << KeePass2::CIPHER_AES256 << true << kdbx4;
  194. QTest::newRow("Argon2d + ChaCha20") << KeePass2::KDF_ARGON2D << KeePass2::CIPHER_CHACHA20 << false << kdbx4;
  195. QTest::newRow("Argon2id + ChaCha20") << KeePass2::KDF_ARGON2ID << KeePass2::CIPHER_CHACHA20 << false << kdbx4;
  196. QTest::newRow("AES-KDF + ChaCha20") << KeePass2::KDF_AES_KDBX4 << KeePass2::CIPHER_CHACHA20 << false << kdbx4;
  197. QTest::newRow("AES-KDF (legacy) + ChaCha20") << KeePass2::KDF_AES_KDBX3 << KeePass2::CIPHER_CHACHA20 << false << kdbx3;
  198. QTest::newRow("Argon2d + ChaCha20 + CustomData") << KeePass2::KDF_ARGON2D << KeePass2::CIPHER_CHACHA20 << true << kdbx4;
  199. QTest::newRow("Argon2id + ChaCha20 + CustomData") << KeePass2::KDF_ARGON2ID << KeePass2::CIPHER_CHACHA20 << true << kdbx4;
  200. QTest::newRow("AES-KDF + ChaCha20 + CustomData") << KeePass2::KDF_AES_KDBX4 << KeePass2::CIPHER_CHACHA20 << true << kdbx4;
  201. QTest::newRow("AES-KDF (legacy) + ChaCha20 + CustomData") << KeePass2::KDF_AES_KDBX3 << KeePass2::CIPHER_CHACHA20 << true << kdbx4;
  202. QTest::newRow("Argon2d + Twofish") << KeePass2::KDF_ARGON2D << KeePass2::CIPHER_TWOFISH << false << kdbx4;
  203. QTest::newRow("Argon2id + Twofish") << KeePass2::KDF_ARGON2ID << KeePass2::CIPHER_TWOFISH << false << kdbx4;
  204. QTest::newRow("AES-KDF + Twofish") << KeePass2::KDF_AES_KDBX4 << KeePass2::CIPHER_TWOFISH << false << kdbx4;
  205. QTest::newRow("AES-KDF (legacy) + Twofish") << KeePass2::KDF_AES_KDBX3 << KeePass2::CIPHER_TWOFISH << false << kdbx3;
  206. QTest::newRow("Argon2d + Twofish + CustomData") << KeePass2::KDF_ARGON2D << KeePass2::CIPHER_TWOFISH << true << kdbx4;
  207. QTest::newRow("Argon2id + Twofish + CustomData") << KeePass2::KDF_ARGON2ID << KeePass2::CIPHER_TWOFISH << true << kdbx4;
  208. QTest::newRow("AES-KDF + Twofish + CustomData") << KeePass2::KDF_AES_KDBX4 << KeePass2::CIPHER_TWOFISH << true << kdbx4;
  209. QTest::newRow("AES-KDF (legacy) + Twofish + CustomData") << KeePass2::KDF_AES_KDBX3 << KeePass2::CIPHER_TWOFISH << true << kdbx4;
  210. }
  211. // clang-format on
  212. void TestKdbx4Format::testFormat410Upgrade()
  213. {
  214. Database db;
  215. db.changeKdf(fastKdf(db.kdf()));
  216. QCOMPARE(db.kdf()->uuid(), KeePass2::KDF_AES_KDBX3);
  217. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_3_1);
  218. auto group1 = new Group();
  219. group1->setUuid(QUuid::createUuid());
  220. group1->setParent(db.rootGroup());
  221. auto group2 = new Group();
  222. group2->setUuid(QUuid::createUuid());
  223. group2->setParent(db.rootGroup());
  224. auto entry = new Entry();
  225. entry->setUuid(QUuid::createUuid());
  226. entry->setGroup(group1);
  227. // Groups with tags
  228. group1->setTags("tag");
  229. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_4_1);
  230. group1->setTags("");
  231. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_3_1);
  232. // PasswordQuality flag set
  233. entry->setExcludeFromReports(true);
  234. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_4_1);
  235. entry->setExcludeFromReports(false);
  236. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_3_1);
  237. // Previous parent group set on group
  238. group1->setPreviousParentGroup(group2);
  239. QCOMPARE(group1->previousParentGroup(), group2);
  240. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_4_1);
  241. group1->setPreviousParentGroup(nullptr);
  242. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_3_1);
  243. // Previous parent group set on entry
  244. entry->setPreviousParentGroup(group2);
  245. QCOMPARE(entry->previousParentGroup(), group2);
  246. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_4_1);
  247. entry->setPreviousParentGroup(nullptr);
  248. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_3_1);
  249. // Custom icons with name or modification date
  250. Metadata::CustomIconData customIcon;
  251. auto iconUuid = QUuid::createUuid();
  252. db.metadata()->addCustomIcon(iconUuid, customIcon);
  253. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_3_1);
  254. customIcon.name = "abc";
  255. db.metadata()->removeCustomIcon(iconUuid);
  256. db.metadata()->addCustomIcon(iconUuid, customIcon);
  257. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_4_1);
  258. customIcon.name.clear();
  259. customIcon.lastModified = Clock::currentDateTimeUtc();
  260. db.metadata()->removeCustomIcon(iconUuid);
  261. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_3_1);
  262. db.metadata()->addCustomIcon(iconUuid, customIcon);
  263. QCOMPARE(KeePass2Writer::kdbxVersionRequired(&db), KeePass2::FILE_VERSION_4_1);
  264. }
  265. void TestKdbx4Format::testUpgradeMasterKeyIntegrity()
  266. {
  267. QFETCH(QString, upgradeAction);
  268. QFETCH(quint32, expectedVersion);
  269. // prepare composite key
  270. auto passwordKey = QSharedPointer<PasswordKey>::create("turXpGMQiUE6CkPvWacydAKsnp4cxz");
  271. QByteArray fileKeyBytes("Ma6hHov98FbPeyAL22XhcgmpJk8xjQ");
  272. QBuffer fileKeyBuffer(&fileKeyBytes);
  273. fileKeyBuffer.open(QBuffer::ReadOnly);
  274. auto fileKey = QSharedPointer<FileKey>::create();
  275. fileKey->load(&fileKeyBuffer);
  276. auto crKey = QSharedPointer<MockChallengeResponseKey>::create(QByteArray("azdJnbVCFE76vV6t9RJ2DS6xvSS93k"));
  277. auto compositeKey = QSharedPointer<CompositeKey>::create();
  278. compositeKey->addKey(passwordKey);
  279. compositeKey->addKey(fileKey);
  280. compositeKey->addChallengeResponseKey(crKey);
  281. QScopedPointer<Database> db(new Database());
  282. db->changeKdf(fastKdf(db->kdf()));
  283. QCOMPARE(db->kdf()->uuid(), KeePass2::KDF_AES_KDBX3); // default is legacy AES-KDF
  284. db->setKey(compositeKey);
  285. // upgrade the database by a specific method
  286. if (upgradeAction == "none") {
  287. // do nothing
  288. } else if (upgradeAction == "meta-customdata") {
  289. db->metadata()->customData()->set("abc", "def");
  290. } else if (upgradeAction == "kdf-aes-kdbx3") {
  291. db->changeKdf(fastKdf(KeePass2::uuidToKdf(KeePass2::KDF_AES_KDBX3)));
  292. } else if (upgradeAction == "kdf-argon2") {
  293. db->changeKdf(fastKdf(KeePass2::uuidToKdf(KeePass2::KDF_ARGON2D)));
  294. } else if (upgradeAction == "kdf-aes-kdbx4") {
  295. db->changeKdf(fastKdf(KeePass2::uuidToKdf(KeePass2::KDF_AES_KDBX4)));
  296. } else if (upgradeAction == "public-customdata") {
  297. db->publicCustomData().insert("abc", "def");
  298. } else if (upgradeAction == "rootgroup-customdata") {
  299. db->rootGroup()->customData()->set("abc", "def");
  300. } else if (upgradeAction == "group-customdata") {
  301. auto group = new Group();
  302. group->setParent(db->rootGroup());
  303. group->setUuid(QUuid::createUuid());
  304. group->customData()->set("abc", "def");
  305. } else if (upgradeAction == "rootentry-customdata") {
  306. auto entry = new Entry();
  307. entry->setGroup(db->rootGroup());
  308. entry->setUuid(QUuid::createUuid());
  309. entry->customData()->set("abc", "def");
  310. } else if (upgradeAction == "entry-customdata") {
  311. auto group = new Group();
  312. group->setParent(db->rootGroup());
  313. group->setUuid(QUuid::createUuid());
  314. auto entry = new Entry();
  315. entry->setGroup(group);
  316. entry->setUuid(QUuid::createUuid());
  317. entry->customData()->set("abc", "def");
  318. } else {
  319. QFAIL(qPrintable(QString("Unknown action: %s").arg(upgradeAction)));
  320. }
  321. QBuffer buffer;
  322. buffer.open(QBuffer::ReadWrite);
  323. KeePass2Writer writer;
  324. QVERIFY(writer.writeDatabase(&buffer, db.data()));
  325. // paranoid check that we cannot decrypt the database without a key
  326. buffer.seek(0);
  327. KeePass2Reader reader;
  328. auto db2 = QSharedPointer<Database>::create();
  329. reader.readDatabase(&buffer, QSharedPointer<CompositeKey>::create(), db2.data());
  330. QVERIFY(reader.hasError());
  331. // check that we can read back the database with the original composite key,
  332. // i.e., no components have been lost on the way
  333. buffer.seek(0);
  334. db2 = QSharedPointer<Database>::create();
  335. reader.readDatabase(&buffer, compositeKey, db2.data());
  336. if (reader.hasError()) {
  337. QFAIL(qPrintable(reader.errorString()));
  338. }
  339. QCOMPARE(reader.version(), expectedVersion);
  340. if (expectedVersion >= KeePass2::FILE_VERSION_4) {
  341. QVERIFY(db2->kdf()->uuid() != KeePass2::KDF_AES_KDBX3);
  342. }
  343. }
  344. void TestKdbx4Format::testUpgradeMasterKeyIntegrity_data()
  345. {
  346. QTest::addColumn<QString>("upgradeAction");
  347. QTest::addColumn<quint32>("expectedVersion");
  348. QTest::newRow("Upgrade: none") << QString("none") << KeePass2::FILE_VERSION_3_1;
  349. QTest::newRow("Upgrade: none (meta-customdata)") << QString("meta-customdata") << KeePass2::FILE_VERSION_3_1;
  350. QTest::newRow("Upgrade: none (explicit kdf-aes-kdbx3)") << QString("kdf-aes-kdbx3") << KeePass2::FILE_VERSION_3_1;
  351. QTest::newRow("Upgrade (explicit): kdf-argon2") << QString("kdf-argon2") << KeePass2::FILE_VERSION_4;
  352. QTest::newRow("Upgrade (explicit): kdf-aes-kdbx4") << QString("kdf-aes-kdbx4") << KeePass2::FILE_VERSION_4;
  353. QTest::newRow("Upgrade (implicit): public-customdata") << QString("public-customdata") << KeePass2::FILE_VERSION_4;
  354. QTest::newRow("Upgrade (implicit): rootgroup-customdata")
  355. << QString("rootgroup-customdata") << KeePass2::FILE_VERSION_4;
  356. QTest::newRow("Upgrade (implicit): group-customdata") << QString("group-customdata") << KeePass2::FILE_VERSION_4;
  357. QTest::newRow("Upgrade (implicit): rootentry-customdata")
  358. << QString("rootentry-customdata") << KeePass2::FILE_VERSION_4;
  359. QTest::newRow("Upgrade (implicit): entry-customdata") << QString("entry-customdata") << KeePass2::FILE_VERSION_4;
  360. }
  361. void TestKdbx4Format::testAttachmentIndexStability()
  362. {
  363. QScopedPointer<Database> db(new Database());
  364. db->changeKdf(fastKdf(KeePass2::uuidToKdf(KeePass2::KDF_ARGON2ID)));
  365. auto compositeKey = QSharedPointer<CompositeKey>::create();
  366. db->setKey(compositeKey);
  367. QVERIFY(!db->uuid().isNull());
  368. auto root = db->rootGroup();
  369. auto group1 = new Group();
  370. group1->setUuid(QUuid::createUuid());
  371. QVERIFY(!group1->uuid().isNull());
  372. group1->setParent(root);
  373. // Simulate KeeShare group, which uses its own attachment namespace
  374. auto group2 = new Group();
  375. group2->setUuid(QUuid::createUuid());
  376. QVERIFY(!group2->uuid().isNull());
  377. group2->setParent(group1);
  378. #ifdef WITH_XC_KEESHARE
  379. KeeShareSettings::Reference ref;
  380. ref.type = KeeShareSettings::SynchronizeWith;
  381. ref.path = "123";
  382. KeeShare::setReferenceTo(group2, ref);
  383. QVERIFY(KeeShare::isShared(group2));
  384. #endif
  385. auto attachment1 = QByteArray("qwerty");
  386. auto attachment2 = QByteArray("asdf");
  387. auto attachment3 = QByteArray("zxcv");
  388. auto entry1 = new Entry();
  389. entry1->setUuid(QUuid::createUuid());
  390. QVERIFY(!entry1->uuid().isNull());
  391. auto uuid1 = entry1->uuid();
  392. entry1->attachments()->set("a", attachment1);
  393. QCOMPARE(entry1->attachments()->keys().size(), 1);
  394. QCOMPARE(entry1->attachments()->values().size(), 1);
  395. entry1->setGroup(root);
  396. auto entry2 = new Entry();
  397. entry2->setUuid(QUuid::createUuid());
  398. QVERIFY(!entry2->uuid().isNull());
  399. auto uuid2 = entry2->uuid();
  400. entry2->attachments()->set("a", attachment1);
  401. entry2->attachments()->set("b", attachment2);
  402. QCOMPARE(entry2->attachments()->keys().size(), 2);
  403. QCOMPARE(entry2->attachments()->values().size(), 2);
  404. entry2->setGroup(group1);
  405. auto entry3 = new Entry();
  406. entry3->setUuid(QUuid::createUuid());
  407. QVERIFY(!entry3->uuid().isNull());
  408. auto uuid3 = entry3->uuid();
  409. entry3->attachments()->set("a", attachment1);
  410. entry3->attachments()->set("b", attachment2);
  411. entry3->attachments()->set("x", attachment3);
  412. entry3->attachments()->set("y", attachment3);
  413. QCOMPARE(entry3->attachments()->keys().size(), 4);
  414. QCOMPARE(entry3->attachments()->values().size(), 3);
  415. entry3->setGroup(group2);
  416. QBuffer buffer;
  417. buffer.open(QBuffer::ReadWrite);
  418. KeePass2Writer writer;
  419. QVERIFY(writer.writeDatabase(&buffer, db.data()));
  420. QVERIFY(writer.version() >= KeePass2::FILE_VERSION_4);
  421. buffer.seek(0);
  422. KeePass2Reader reader;
  423. // Re-read database and check that all attachments are still correctly assigned
  424. auto db2 = QSharedPointer<Database>::create();
  425. reader.readDatabase(&buffer, QSharedPointer<CompositeKey>::create(), db2.data());
  426. QVERIFY(!reader.hasError());
  427. QVERIFY(!db->uuid().isNull());
  428. auto a1 = db2->rootGroup()->findEntryByUuid(uuid1)->attachments();
  429. QCOMPARE(a1->keys().size(), 1);
  430. QCOMPARE(a1->values().size(), 1);
  431. QCOMPARE(a1->value("a"), attachment1);
  432. auto a2 = db2->rootGroup()->findEntryByUuid(uuid2)->attachments();
  433. QCOMPARE(a2->keys().size(), 2);
  434. QCOMPARE(a2->values().size(), 2);
  435. QCOMPARE(a2->value("a"), attachment1);
  436. QCOMPARE(a2->value("b"), attachment2);
  437. #ifdef WITH_XC_KEESHARE
  438. QVERIFY(KeeShare::isShared(db2->rootGroup()->findEntryByUuid(uuid3)->group()));
  439. #endif
  440. auto a3 = db2->rootGroup()->findEntryByUuid(uuid3)->attachments();
  441. QCOMPARE(a3->keys().size(), 4);
  442. QCOMPARE(a3->values().size(), 3);
  443. QCOMPARE(a3->value("a"), attachment1);
  444. QCOMPARE(a3->value("b"), attachment2);
  445. QCOMPARE(a3->value("x"), attachment3);
  446. QCOMPARE(a3->value("y"), attachment3);
  447. }
  448. void TestKdbx4Format::testCustomData()
  449. {
  450. Database db;
  451. // test public custom data
  452. QVariantMap publicCustomData;
  453. publicCustomData.insert("CD1", 123);
  454. publicCustomData.insert("CD2", true);
  455. publicCustomData.insert("CD3", "abcäöü");
  456. db.setPublicCustomData(publicCustomData);
  457. publicCustomData.insert("CD4", QByteArray::fromHex("ababa123ff"));
  458. db.publicCustomData().insert("CD4", publicCustomData.value("CD4"));
  459. QCOMPARE(db.publicCustomData(), publicCustomData);
  460. const QString customDataKey1 = "CD1";
  461. const QString customDataKey2 = "CD2";
  462. const QString customData1 = "abcäöü";
  463. const QString customData2 = "Hello World";
  464. // test custom database data
  465. db.metadata()->customData()->set(customDataKey1, customData1);
  466. db.metadata()->customData()->set(customDataKey2, customData2);
  467. auto lastModified = db.metadata()->customData()->value(CustomData::LastModified);
  468. const int dataSize = customDataKey1.toUtf8().size() + customDataKey2.toUtf8().size() + customData1.toUtf8().size()
  469. + customData2.toUtf8().size() + lastModified.toUtf8().size()
  470. + CustomData::LastModified.toUtf8().size();
  471. QCOMPARE(db.metadata()->customData()->size(), 3);
  472. QCOMPARE(db.metadata()->customData()->dataSize(), dataSize);
  473. // test custom root group data
  474. Group* root = db.rootGroup();
  475. root->customData()->set(customDataKey1, customData1);
  476. root->customData()->set(customDataKey2, customData2);
  477. QCOMPARE(root->customData()->size(), 3);
  478. QCOMPARE(root->customData()->dataSize(), dataSize);
  479. // test copied custom group data
  480. auto* group = new Group();
  481. group->setParent(root);
  482. group->setUuid(QUuid::createUuid());
  483. group->customData()->copyDataFrom(root->customData());
  484. QCOMPARE(*group->customData(), *root->customData());
  485. // test copied custom entry data
  486. auto* entry = new Entry();
  487. entry->setGroup(group);
  488. entry->setUuid(QUuid::createUuid());
  489. entry->customData()->copyDataFrom(group->customData());
  490. QCOMPARE(*entry->customData(), *root->customData());
  491. // test custom data deletion
  492. entry->customData()->set("additional item", "foobar");
  493. QCOMPARE(entry->customData()->size(), 4);
  494. entry->customData()->remove("additional item");
  495. QCOMPARE(entry->customData()->size(), 3);
  496. QCOMPARE(entry->customData()->dataSize(), dataSize);
  497. // test custom data on cloned groups
  498. QScopedPointer<Group> clonedGroup(group->clone());
  499. QCOMPARE(*clonedGroup->customData(), *group->customData());
  500. // test custom data on cloned entries
  501. QScopedPointer<Entry> clonedEntry(entry->clone(Entry::CloneNoFlags));
  502. QCOMPARE(*clonedEntry->customData(), *entry->customData());
  503. QBuffer buffer;
  504. buffer.open(QBuffer::ReadWrite);
  505. KeePass2Writer writer;
  506. writer.writeDatabase(&buffer, &db);
  507. // read buffer back
  508. buffer.seek(0);
  509. KeePass2Reader reader;
  510. auto newDb = QSharedPointer<Database>::create();
  511. reader.readDatabase(&buffer, QSharedPointer<CompositeKey>::create(), newDb.data());
  512. // test all custom data are read back successfully from KDBX
  513. QCOMPARE(newDb->publicCustomData(), publicCustomData);
  514. QCOMPARE(newDb->metadata()->customData()->value(customDataKey1), customData1);
  515. QCOMPARE(newDb->metadata()->customData()->value(customDataKey2), customData2);
  516. QCOMPARE(newDb->rootGroup()->customData()->value(customDataKey1), customData1);
  517. QCOMPARE(newDb->rootGroup()->customData()->value(customDataKey2), customData2);
  518. auto* newGroup = newDb->rootGroup()->children()[0];
  519. QCOMPARE(newGroup->customData()->value(customDataKey1), customData1);
  520. QCOMPARE(newGroup->customData()->value(customDataKey2), customData2);
  521. auto* newEntry = newDb->rootGroup()->children()[0]->entries()[0];
  522. QCOMPARE(newEntry->customData()->value(customDataKey1), customData1);
  523. QCOMPARE(newEntry->customData()->value(customDataKey2), customData2);
  524. }