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)
89 lines
2.5 KiB
C++
89 lines
2.5 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/>.
|
|
*/
|
|
|
|
#include "KdbxWriter.h"
|
|
|
|
#include <QBuffer>
|
|
|
|
#include "format/KdbxXmlWriter.h"
|
|
|
|
bool KdbxWriter::hasError() const
|
|
{
|
|
return m_error;
|
|
}
|
|
|
|
QString KdbxWriter::errorString() const
|
|
{
|
|
return m_errorStr;
|
|
}
|
|
|
|
/**
|
|
* Write KDBX magic header numbers to a device.
|
|
*
|
|
* @param device output device
|
|
* @param sig1 KDBX signature 1
|
|
* @param sig2 KDBX signature 2
|
|
* @param version KDBX version
|
|
* @return true if magic numbers were written successfully
|
|
*/
|
|
bool KdbxWriter::writeMagicNumbers(QIODevice* device, quint32 sig1, quint32 sig2, quint32 version)
|
|
{
|
|
CHECK_RETURN_FALSE(writeData(device, Endian::sizedIntToBytes<qint32>(sig1, KeePass2::BYTEORDER)));
|
|
CHECK_RETURN_FALSE(writeData(device, Endian::sizedIntToBytes<qint32>(sig2, KeePass2::BYTEORDER)));
|
|
CHECK_RETURN_FALSE(writeData(device, Endian::sizedIntToBytes<qint32>(version, KeePass2::BYTEORDER)));
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Helper method for writing bytes to the device and raising an error
|
|
* in case of write failure.
|
|
*
|
|
* @param device output device
|
|
* @param data byte contents
|
|
* @return true on success
|
|
*/
|
|
bool KdbxWriter::writeData(QIODevice* device, const QByteArray& data)
|
|
{
|
|
if (device->write(data) != data.size()) {
|
|
raiseError(device->errorString());
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void KdbxWriter::extractDatabase(QByteArray& xmlOutput, Database* db)
|
|
{
|
|
QBuffer buffer;
|
|
buffer.setBuffer(&xmlOutput);
|
|
buffer.open(QIODevice::WriteOnly);
|
|
KdbxXmlWriter writer(formatVersion());
|
|
writer.disableInnerStreamProtection(true);
|
|
writer.writeDatabase(&buffer, db);
|
|
}
|
|
|
|
/**
|
|
* Raise an error. Use in case of an unexpected write error.
|
|
*
|
|
* @param errorMessage error message
|
|
*/
|
|
void KdbxWriter::raiseError(const QString& errorMessage)
|
|
{
|
|
m_error = true;
|
|
m_errorStr = errorMessage;
|
|
}
|