2
* Copyright (C) 2017 KeePassXC Team <team@keepassxc.org>
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.
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.
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/>.
20
#include "core/Group.h"
21
#include "core/Metadata.h"
22
#include "format/Kdbx3Writer.h"
23
#include "format/Kdbx4Writer.h"
24
#include "format/KeePass2Writer.h"
27
* Write a database to a KDBX file.
29
* @param filename output filename
30
* @param db source database
31
* @return true on success
33
bool KeePass2Writer::writeDatabase(const QString& filename, Database* db)
36
if (!file.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
37
raiseError(file.errorString());
40
return writeDatabase(&file, db);
43
#define VERSION_MAX(a, b) \
45
if (a >= KeePass2::FILE_VERSION_MAX) { \
50
* Get the minimum KDBX version required for writing the database.
52
quint32 KeePass2Writer::kdbxVersionRequired(Database const* db, bool ignoreCurrent, bool ignoreKdf)
54
quint32 version = KeePass2::FILE_VERSION_3_1;
56
VERSION_MAX(version, db->formatVersion())
59
if (!ignoreKdf && !db->kdf().isNull() && !db->kdf()->uuid().isNull()
60
&& db->kdf()->uuid() != KeePass2::KDF_AES_KDBX3) {
61
VERSION_MAX(version, KeePass2::FILE_VERSION_4)
64
if (!db->publicCustomData().isEmpty()) {
65
VERSION_MAX(version, KeePass2::FILE_VERSION_4)
68
for (const auto* group : db->rootGroup()->groupsRecursive(true)) {
69
if (group->customData() && !group->customData()->isEmpty()) {
70
VERSION_MAX(version, KeePass2::FILE_VERSION_4)
72
if (!group->tags().isEmpty()) {
73
VERSION_MAX(version, KeePass2::FILE_VERSION_4_1)
75
if (group->previousParentGroup()) {
76
VERSION_MAX(version, KeePass2::FILE_VERSION_4_1)
79
for (const auto* entry : group->entries()) {
81
if (entry->customData() && !entry->customData()->isEmpty()) {
82
VERSION_MAX(version, KeePass2::FILE_VERSION_4)
84
if (entry->excludeFromReports()) {
85
VERSION_MAX(version, KeePass2::FILE_VERSION_4_1)
87
if (entry->previousParentGroup()) {
88
VERSION_MAX(version, KeePass2::FILE_VERSION_4_1)
91
for (const auto* historyItem : entry->historyItems()) {
92
if (historyItem->customData() && !historyItem->customData()->isEmpty()) {
93
VERSION_MAX(version, KeePass2::FILE_VERSION_4)
99
const QList<QUuid> customIconsOrder = db->metadata()->customIconsOrder();
100
for (const QUuid& uuid : customIconsOrder) {
101
const auto& icon = db->metadata()->customIcon(uuid);
102
if (!icon.name.isEmpty() || icon.lastModified.isValid()) {
103
VERSION_MAX(version, KeePass2::FILE_VERSION_4_1)
111
* Write a database to a device in KDBX format.
113
* @param device output device
114
* @param db source database
115
* @return true on success
117
bool KeePass2Writer::writeDatabase(QIODevice* device, Database* db)
122
m_version = kdbxVersionRequired(db);
123
if (db->kdf()->uuid() == KeePass2::KDF_AES_KDBX3 && m_version >= KeePass2::FILE_VERSION_4) {
124
// We MUST re-transform the key, because challenge-response hashing has changed in KDBX 4.
125
// If we forget to re-transform, the database will be saved WITHOUT a challenge-response key component!
126
auto kdf = KeePass2::uuidToKdf(KeePass2::KDF_AES_KDBX4);
127
kdf->setRounds(db->kdf()->rounds());
131
db->setFormatVersion(m_version);
132
if (db->kdf()->uuid() == KeePass2::KDF_AES_KDBX3) {
133
Q_ASSERT(m_version <= KeePass2::FILE_VERSION_3_1);
134
m_writer.reset(new Kdbx3Writer());
136
Q_ASSERT(m_version >= KeePass2::FILE_VERSION_4);
137
m_writer.reset(new Kdbx4Writer());
140
return m_writer->writeDatabase(device, db);
143
void KeePass2Writer::extractDatabase(Database* db, QByteArray& xmlOutput)
148
m_version = kdbxVersionRequired(db);
149
db->setFormatVersion(m_version);
150
if (db->kdf()->uuid() == KeePass2::KDF_AES_KDBX3) {
151
Q_ASSERT(m_version <= KeePass2::FILE_VERSION_3_1);
152
m_writer.reset(new Kdbx3Writer());
154
Q_ASSERT(m_version >= KeePass2::FILE_VERSION_4);
155
m_writer.reset(new Kdbx4Writer());
158
m_writer->extractDatabase(xmlOutput, db);
161
bool KeePass2Writer::hasError() const
163
return m_error || (m_writer && m_writer->hasError());
166
QString KeePass2Writer::errorString() const
168
return m_writer ? m_writer->errorString() : m_errorStr;
172
* Raise an error. Use in case of an unexpected write error.
174
* @param errorMessage error message
176
void KeePass2Writer::raiseError(const QString& errorMessage)
179
m_errorStr = errorMessage;
183
* @return KDBX writer used for writing the output file
185
QSharedPointer<KdbxWriter> KeePass2Writer::writer() const
191
* @return KDBX version used for writing the output file
193
quint32 KeePass2Writer::version() const