mirror of
https://github.com/keepassxreboot/keepassxc.git
synced 2025-02-02 09:34:58 -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)
103 lines
3.3 KiB
C++
103 lines
3.3 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_KDBXREADER_H
|
|
#define KEEPASSXC_KDBXREADER_H
|
|
|
|
#include "KeePass2.h"
|
|
#include "keys/CompositeKey.h"
|
|
#include "streams/StoreDataStream.h"
|
|
|
|
#include <QCoreApplication>
|
|
#include <QPointer>
|
|
|
|
class Database;
|
|
class QIODevice;
|
|
|
|
/**
|
|
* Abstract KDBX reader base class.
|
|
*/
|
|
class KdbxReader
|
|
{
|
|
Q_DECLARE_TR_FUNCTIONS(KdbxReader)
|
|
|
|
public:
|
|
KdbxReader() = default;
|
|
virtual ~KdbxReader() = default;
|
|
|
|
static bool readMagicNumbers(QIODevice* device, quint32& sig1, quint32& sig2, quint32& version);
|
|
bool readDatabase(QIODevice* device, QSharedPointer<const CompositeKey> key, Database* db);
|
|
|
|
bool hasError() const;
|
|
QString errorString() const;
|
|
|
|
KeePass2::ProtectedStreamAlgo protectedStreamAlgo() const;
|
|
|
|
protected:
|
|
/**
|
|
* Concrete reader implementation for reading database from device.
|
|
*
|
|
* @param device input device at the payload starting position
|
|
* @param KDBX header data as bytes
|
|
* @param key database encryption composite key
|
|
* @param db database to read into
|
|
* @return true on success
|
|
*/
|
|
virtual bool readDatabaseImpl(QIODevice* device,
|
|
const QByteArray& headerData,
|
|
QSharedPointer<const CompositeKey> key,
|
|
Database* db) = 0;
|
|
|
|
/**
|
|
* Read next header field from stream.
|
|
*
|
|
* @param headerStream input header stream
|
|
* @param database to read header field for
|
|
* @return true if there are more header fields
|
|
*/
|
|
virtual bool readHeaderField(StoreDataStream& headerStream, Database* db) = 0;
|
|
|
|
virtual void setCipher(const QByteArray& data);
|
|
virtual void setCompressionFlags(const QByteArray& data);
|
|
virtual void setMasterSeed(const QByteArray& data);
|
|
virtual void setTransformSeed(const QByteArray& data);
|
|
virtual void setTransformRounds(const QByteArray& data);
|
|
virtual void setEncryptionIV(const QByteArray& data);
|
|
virtual void setProtectedStreamKey(const QByteArray& data);
|
|
virtual void setStreamStartBytes(const QByteArray& data);
|
|
virtual void setInnerRandomStreamID(const QByteArray& data);
|
|
|
|
void raiseError(const QString& errorMessage);
|
|
|
|
quint32 m_kdbxVersion = 0;
|
|
|
|
QByteArray m_masterSeed;
|
|
QByteArray m_encryptionIV;
|
|
QByteArray m_streamStartBytes;
|
|
QByteArray m_protectedStreamKey;
|
|
KeePass2::ProtectedStreamAlgo m_irsAlgo = KeePass2::ProtectedStreamAlgo::InvalidProtectedStreamAlgo;
|
|
|
|
private:
|
|
QPair<quint32, quint32> m_kdbxSignature;
|
|
QPointer<Database> m_db;
|
|
|
|
bool m_error = false;
|
|
QString m_errorStr = "";
|
|
};
|
|
|
|
#endif // KEEPASSXC_KDBXREADER_H
|