keepassxc/src/format/KdbxReader.h
Janek Bevendorff a6ddc22fb8
Refactor database readers/writers and XML handling
* Refactor Kdbx*Reader
* Refactor KdbxWriter
* Refactor KdbxXmlReader
* Refactor KdbxXmlWriter
2018-01-13 14:24:58 -05:00

108 lines
3.4 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);
Database* readDatabase(QIODevice* device, const CompositeKey& key, bool keepDatabase = false);
bool hasError() const;
QString errorString() const;
bool saveXml() const;
void setSaveXml(bool save);
QByteArray xmlData() const;
QByteArray streamKey() 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 keepDatabase keep database in case of read failure
* @return pointer to the read database, nullptr on failure
*/
virtual Database* readDatabaseImpl(QIODevice* device, const QByteArray& headerData,
const CompositeKey& key, bool keepDatabase) = 0;
/**
* Read next header field from stream.
*
* @param headerStream input header stream
* @return true if there are more header fields
*/
virtual bool readHeaderField(StoreDataStream& headerStream) = 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);
QScopedPointer<Database> m_db;
QPair<quint32, quint32> m_kdbxSignature;
quint32 m_kdbxVersion = 0;
QByteArray m_masterSeed;
QByteArray m_encryptionIV;
QByteArray m_streamStartBytes;
QByteArray m_protectedStreamKey;
KeePass2::ProtectedStreamAlgo m_irsAlgo = KeePass2::ProtectedStreamAlgo::InvalidProtectedStreamAlgo;
QByteArray m_xmlData;
private:
bool m_saveXml = false;
bool m_error = false;
QString m_errorStr = "";
};
#endif //KEEPASSXC_KDBXREADER_H