qt: Report better error if decryption failed because of bad passphrase

* lang/qt/src/qgpgmedecryptverifyjob.cpp (patch_decryption_result): New.
(decrypt_verify): Call patch_decryption_result.
--

Replace the generic "decryption failed" error with the more specific
"bad passphrase" error if the audit log indicates that a wrong symmetric
password caused the decryption to fail.

GnuPG-bug-id: 5939
This commit is contained in:
Ingo Klöcker 2022-04-22 17:34:41 +02:00
parent 321c8a0254
commit d8e5871dca

View File

@ -49,6 +49,7 @@
#include "qgpgme_debug.h" #include "qgpgme_debug.h"
#include <QBuffer> #include <QBuffer>
#include <QRegularExpression>
#include <cassert> #include <cassert>
@ -63,12 +64,23 @@ QGpgMEDecryptVerifyJob::QGpgMEDecryptVerifyJob(Context *context)
QGpgMEDecryptVerifyJob::~QGpgMEDecryptVerifyJob() {} QGpgMEDecryptVerifyJob::~QGpgMEDecryptVerifyJob() {}
static void patch_decryption_result(DecryptionResult &result, const QString &auditLog)
{
if (result.error().code() == GPG_ERR_DECRYPT_FAILED) {
// check for wrong symmetric password
if (auditLog.contains(QLatin1String{"gpg: decryption of the symmetrically encrypted session key failed: Checksum error"})
|| (auditLog.contains(QRegularExpression{QStringLiteral("gpg: encrypted with \\d+ passphrase")})
&& auditLog.contains(QLatin1String{"gpg: decryption failed: Bad session key"}))) {
result.setError(Error::fromCode(GPG_ERR_BAD_PASSPHRASE));
}
}
}
static QGpgMEDecryptVerifyJob::result_type decrypt_verify(Context *ctx, QThread *thread, static QGpgMEDecryptVerifyJob::result_type decrypt_verify(Context *ctx, QThread *thread,
const std::weak_ptr<QIODevice> &cipherText_, const std::weak_ptr<QIODevice> &cipherText_,
const std::weak_ptr<QIODevice> &plainText_) const std::weak_ptr<QIODevice> &plainText_)
{ {
qCDebug(QGPGME_LOG) << __func__;
qCDebug(QGPGME_LOG);
const std::shared_ptr<QIODevice> cipherText = cipherText_.lock(); const std::shared_ptr<QIODevice> cipherText = cipherText_.lock();
const std::shared_ptr<QIODevice> plainText = plainText_.lock(); const std::shared_ptr<QIODevice> plainText = plainText_.lock();
@ -83,22 +95,23 @@ static QGpgMEDecryptVerifyJob::result_type decrypt_verify(Context *ctx, QThread
QGpgME::QByteArrayDataProvider out; QGpgME::QByteArrayDataProvider out;
Data outdata(&out); Data outdata(&out);
const std::pair<DecryptionResult, VerificationResult> res = ctx->decryptAndVerify(indata, outdata); std::pair<DecryptionResult, VerificationResult> res = ctx->decryptAndVerify(indata, outdata);
Error ae; Error ae;
const QString log = _detail::audit_log_as_html(ctx, ae); const QString log = _detail::audit_log_as_html(ctx, ae);
qCDebug(QGPGME_LOG) << "End no plainText. Error: " << ae; qCDebug(QGPGME_LOG) << __func__ << "- End no plainText. Error:" << ae.asString();
patch_decryption_result(res.first, log);
return std::make_tuple(res.first, res.second, out.data(), log, ae); return std::make_tuple(res.first, res.second, out.data(), log, ae);
} else { } else {
QGpgME::QIODeviceDataProvider out(plainText); QGpgME::QIODeviceDataProvider out(plainText);
Data outdata(&out); Data outdata(&out);
const std::pair<DecryptionResult, VerificationResult> res = ctx->decryptAndVerify(indata, outdata); std::pair<DecryptionResult, VerificationResult> res = ctx->decryptAndVerify(indata, outdata);
Error ae; Error ae;
const QString log = _detail::audit_log_as_html(ctx, ae); const QString log = _detail::audit_log_as_html(ctx, ae);
qCDebug(QGPGME_LOG) << "End plainText. Error: " << ae; qCDebug(QGPGME_LOG) << __func__ << "- End plainText. Error:" << ae.asString();
patch_decryption_result(res.first, log);
return std::make_tuple(res.first, res.second, QByteArray(), log, ae); return std::make_tuple(res.first, res.second, QByteArray(), log, ae);
} }
} }
static QGpgMEDecryptVerifyJob::result_type decrypt_verify_qba(Context *ctx, const QByteArray &cipherText) static QGpgMEDecryptVerifyJob::result_type decrypt_verify_qba(Context *ctx, const QByteArray &cipherText)