mirror of
https://github.com/keepassxreboot/keepassxc.git
synced 2025-01-07 05:28:17 -05:00
504904a414
Previously, extracting the XML from a database was done with the `saveXml` attribute in the `KeePass2Reader` class. This had several unfortunate consequences: * The `KdbxReader` class had to import the `KdbxXmlWriter` class in order to perform the export (bad separation of concerns); * The CLI database unlocking logic had to be duplicated only for the `Extract` command; * The `xmlData` had to be stored in the `KeePass2Reader` as a temporary result. * Lots of `setSaveXml` functions were implemented only to trickle down this functionality. Also, the naming of the `saveXml` variable was not really helpful to understand it's role. Overall, this change will make it easier to maintain and expand the CLI database unlocking logic (for example, adding a `--no-password` option as requested in https://github.com/keepassxreboot/keepassxc/issues/1873) It also opens to door to other types of extraction/exporting (for example exporting to CSV, as requested in https://github.com/keepassxreboot/keepassxc/issues/2572)
98 lines
2.8 KiB
C++
98 lines
2.8 KiB
C++
/*
|
|
* Copyright (C) 2018 KeePassXC Team <team@keepassxc.org>
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 or (at your option)
|
|
* version 3 of the License.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef KEEPASSXC_KDBXWRITER_H
|
|
#define KEEPASSXC_KDBXWRITER_H
|
|
|
|
#include "KeePass2.h"
|
|
#include "core/Endian.h"
|
|
|
|
#include <QCoreApplication>
|
|
|
|
// clang-format off
|
|
#define CHECK_RETURN_FALSE(x) if (!(x)) return false;
|
|
// clang-format on
|
|
|
|
class QIODevice;
|
|
class Database;
|
|
|
|
/**
|
|
* Abstract KDBX writer base class.
|
|
*/
|
|
class KdbxWriter
|
|
{
|
|
Q_DECLARE_TR_FUNCTIONS(KdbxWriter)
|
|
|
|
public:
|
|
KdbxWriter() = default;
|
|
virtual ~KdbxWriter() = default;
|
|
|
|
bool writeMagicNumbers(QIODevice* device, quint32 sig1, quint32 sig2, quint32 version);
|
|
|
|
/**
|
|
* Write a database to a device in KDBX format.
|
|
*
|
|
* @param device output device
|
|
* @param db source database
|
|
* @return true on success
|
|
*/
|
|
virtual bool writeDatabase(QIODevice* device, Database* db) = 0;
|
|
|
|
/**
|
|
* Get the database format version for the writer.
|
|
*/
|
|
virtual quint32 formatVersion() = 0;
|
|
|
|
void extractDatabase(QByteArray& xmlOutput, Database* db);
|
|
|
|
bool hasError() const;
|
|
QString errorString() const;
|
|
|
|
protected:
|
|
/**
|
|
* Helper method for writing a KDBX header field to a device.
|
|
*
|
|
* @tparam SizedQInt field width
|
|
* @param device output device
|
|
* @param fieldId field identifier
|
|
* @param data field contents
|
|
* @return true on success
|
|
*/
|
|
template <typename SizedQInt>
|
|
bool writeHeaderField(QIODevice* device, KeePass2::HeaderFieldID fieldId, const QByteArray& data)
|
|
{
|
|
Q_ASSERT(static_cast<unsigned long>(data.size()) < (1ull << (sizeof(SizedQInt) * 8)));
|
|
|
|
QByteArray fieldIdArr;
|
|
fieldIdArr[0] = static_cast<char>(fieldId);
|
|
CHECK_RETURN_FALSE(writeData(device, fieldIdArr));
|
|
CHECK_RETURN_FALSE(writeData(
|
|
device, Endian::sizedIntToBytes<SizedQInt>(static_cast<SizedQInt>(data.size()), KeePass2::BYTEORDER)));
|
|
CHECK_RETURN_FALSE(writeData(device, data));
|
|
|
|
return true;
|
|
}
|
|
|
|
bool writeData(QIODevice* device, const QByteArray& data);
|
|
void raiseError(const QString& errorMessage);
|
|
|
|
bool m_error = false;
|
|
QString m_errorStr = "";
|
|
};
|
|
|
|
#endif // KEEPASSXC_KDBXWRITER_H
|