Skip to content

Commit

Permalink
Fix crash on screen lock or computer sleep
Browse files Browse the repository at this point in the history
* Fixes #10455
* Fixes #10432
* Fixes #10415

Prevent setting critical key components to nullptr when database data is cleared. This can result in a crash due to race condition between threads.

Added a bunch of asserts to detect this problem and if guards to prevent actual crashes.
  • Loading branch information
droidmonkey committed Apr 13, 2024
1 parent f60601f commit 6481ecc
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 23 deletions.
19 changes: 16 additions & 3 deletions src/core/Database.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,9 @@ bool Database::performSave(const QString& filePath, SaveAction action, const QSt

bool Database::writeDatabase(QIODevice* device, QString* error)
{
Q_ASSERT(m_data.key);
Q_ASSERT(m_data.transformedDatabaseKey);

PasswordKey oldTransformedKey;
if (m_data.key->isEmpty()) {
oldTransformedKey.setRawKey(m_data.transformedDatabaseKey->rawKey());
Expand Down Expand Up @@ -767,18 +770,29 @@ Database::CompressionAlgorithm Database::compressionAlgorithm() const

QByteArray Database::transformedDatabaseKey() const
{
Q_ASSERT(m_data.transformedDatabaseKey);
if (!m_data.transformedDatabaseKey) {
return {};
}
return m_data.transformedDatabaseKey->rawKey();
}

QByteArray Database::challengeResponseKey() const
{
Q_ASSERT(m_data.challengeResponseKey);
if (!m_data.challengeResponseKey) {
return {};
}
return m_data.challengeResponseKey->rawKey();
}

bool Database::challengeMasterSeed(const QByteArray& masterSeed)
{
Q_ASSERT(m_data.key);
Q_ASSERT(m_data.masterSeed);

m_keyError.clear();
if (m_data.key) {
if (m_data.key && m_data.masterSeed) {
m_data.masterSeed->setRawKey(masterSeed);
QByteArray response;
bool ok = m_data.key->challenge(masterSeed, response, &m_keyError);
Expand Down Expand Up @@ -824,8 +838,7 @@ bool Database::setKey(const QSharedPointer<const CompositeKey>& key,
m_keyError.clear();

if (!key) {
m_data.key.reset();
m_data.transformedDatabaseKey.reset(new PasswordKey());
m_data.resetKeys();
return true;
}

Expand Down
23 changes: 13 additions & 10 deletions src/core/Database.h
Original file line number Diff line number Diff line change
Expand Up @@ -188,30 +188,33 @@ public slots:
QScopedPointer<PasswordKey> challengeResponseKey;

QSharedPointer<const CompositeKey> key;
QSharedPointer<Kdf> kdf = QSharedPointer<AesKdf>::create(true);
QSharedPointer<Kdf> kdf;

QVariantMap publicCustomData;

DatabaseData()
: masterSeed(new PasswordKey())
, transformedDatabaseKey(new PasswordKey())
, challengeResponseKey(new PasswordKey())
{
kdf->randomizeSeed();
clear();
}

void clear()
{
resetKeys();
filePath.clear();
publicCustomData.clear();
}

masterSeed.reset();
transformedDatabaseKey.reset();
challengeResponseKey.reset();
void resetKeys()
{
masterSeed.reset(new PasswordKey());
transformedDatabaseKey.reset(new PasswordKey());
challengeResponseKey.reset(new PasswordKey());

key.reset();
kdf.reset();

publicCustomData.clear();
// Default to AES KDF, KDBX4 databases overwrite this
kdf.reset(new AesKdf(true));
kdf->randomizeSeed();
}
};

Expand Down
4 changes: 1 addition & 3 deletions src/gui/DatabaseOpenWidget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,7 @@ void DatabaseOpenWidget::clearForms()
m_ui->hardwareKeyCombo->clear();
toggleQuickUnlockScreen();

QString error;
m_db.reset(new Database());
m_db->open(m_filename, nullptr, &error);
m_db.reset(new Database(m_filename));
}

QSharedPointer<Database> DatabaseOpenWidget::database()
Expand Down
11 changes: 6 additions & 5 deletions src/gui/dbsettings/DatabaseSettingsWidgetEncryption.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -101,22 +101,23 @@ void DatabaseSettingsWidgetEncryption::initialize()
}

auto version = KDBX4;
if (m_db->kdf()) {
if (m_db->key() && m_db->kdf()) {
version = (m_db->kdf()->uuid() == KeePass2::KDF_AES_KDBX3) ? KDBX3 : KDBX4;
}
m_ui->compatibilitySelection->setCurrentIndex(version);

bool isNewDatabase = false;

if (!m_db->kdf()) {
m_db->setKdf(KeePass2::uuidToKdf(KeePass2::KDF_ARGON2D));
isNewDatabase = true;
}
if (!m_db->key()) {
m_db->setKey(QSharedPointer<CompositeKey>::create(), true, false, false);
m_db->setKdf(KeePass2::uuidToKdf(KeePass2::KDF_ARGON2D));
m_db->setCipher(KeePass2::CIPHER_AES256);
isNewDatabase = true;
} else if (!m_db->kdf()) {
m_db->setKdf(KeePass2::uuidToKdf(KeePass2::KDF_ARGON2D));
isNewDatabase = true;
}

bool kdbx3Enabled = KeePass2Writer::kdbxVersionRequired(m_db.data(), true, true) <= KeePass2::FILE_VERSION_3_1;

// check if the DB's custom data has a decryption time setting stored
Expand Down
8 changes: 6 additions & 2 deletions tests/TestKeePass2Format.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,9 @@ void TestKeePass2Format::testKdbxKeyChange()

db->setKey(key1);
writeKdbx(&buffer, db.data(), hasError, errorString);
QVERIFY(!hasError);
if (hasError) {
QFAIL(qPrintable(QStringLiteral("Error while reading database: ").append(errorString)));
}

// read database
db = QSharedPointer<Database>::create();
Expand All @@ -599,7 +601,9 @@ void TestKeePass2Format::testKdbxKeyChange()
// write database
buffer.seek(0);
writeKdbx(&buffer, db.data(), hasError, errorString);
QVERIFY(!hasError);
if (hasError) {
QFAIL(qPrintable(QStringLiteral("Error while reading database: ").append(errorString)));
}

// read database
db = QSharedPointer<Database>::create();
Expand Down

4 comments on commit 6481ecc

@darix
Copy link

@darix darix commented on 6481ecc Apr 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this a patch that distributions should/can cherry pick or will we see a new release soon?

@droidmonkey
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@darix
Copy link

@darix darix commented on 6481ecc Apr 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is no source tarball so :) I am asking as a packager not as an user.

@droidmonkey
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Download the develop branch source. This isn't put to a release yet...

Please sign in to comment.