1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
|
// SPDX-FileCopyrightText: 2021 Daniel Vrátil <dvratil@kde.org>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#include "providerbase.h"
#include "klipperinterface.h"
#include "plasmapass_debug.h"
#include <QClipboard>
#include <QCryptographicHash>
#include <QGuiApplication>
#include <QMimeData>
#include <QProcess>
#include <QStandardPaths>
#include <QDBusConnection>
#include <Plasma5Support/DataEngine>
#include <Plasma5Support/DataEngineConsumer>
#include <Plasma5Support/PluginLoader>
#include <Plasma5Support/Service>
#include <Plasma5Support/ServiceJob>
#include <KLocalizedString>
#include <chrono>
#include <utility>
#include <QGpgME/DecryptJob>
#include <QGpgME/Protocol>
#include <gpgme++/decryptionresult.h>
using namespace std::chrono;
using namespace std::chrono_literals;
using namespace PlasmaPass;
namespace
{
constexpr const auto DefaultSecretTimeout = 45s;
constexpr const auto SecretTimeoutUpdateInterval = 100ms;
const QString klipperDBusService = QStringLiteral("org.kde.klipper");
const QString klipperDBusPath = QStringLiteral("/klipper");
const QString klipperDataEngine = QStringLiteral("org.kde.plasma.clipboard");
}
KlipperUtils::State ProviderBase::sKlipperState = KlipperUtils::State::Unknown;
ProviderBase::ProviderBase(const QString &path, QObject *parent)
: QObject(parent)
, mPath(path)
, mSecretTimeout(DefaultSecretTimeout)
{
mTimer.setInterval(SecretTimeoutUpdateInterval);
connect(&mTimer, &QTimer::timeout, this, [this]() {
mTimeout -= mTimer.interval();
Q_EMIT timeoutChanged();
if (mTimeout == 0) {
expireSecret();
}
});
QTimer::singleShot(0, this, &ProviderBase::start);
}
ProviderBase::~ProviderBase() = default;
void ProviderBase::start()
{
QFile file(mPath);
if (!file.open(QIODevice::ReadOnly)) {
qCWarning(PLASMAPASS_LOG, "Failed to open password file: %s", qUtf8Printable(file.errorString()));
setError(i18n("Failed to open password file: %1", file.errorString()));
return;
}
auto decryptJob = QGpgME::openpgp()->decryptJob();
connect(decryptJob, &QGpgME::DecryptJob::result, this, [this](const GpgME::DecryptionResult &result, const QByteArray &plainText) {
if (result.error()) {
qCWarning(PLASMAPASS_LOG, "Failed to decrypt password: %s", result.error().asString());
setError(i18n("Failed to decrypt password: %1", QString::fromUtf8(result.error().asString())));
return;
}
const auto data = QString::fromUtf8(plainText);
if (data.isEmpty()) {
qCWarning(PLASMAPASS_LOG, "Password file is empty!");
setError(i18n("No password found"));
return;
}
const auto lines = QStringView(data).split(QLatin1Char('\n'));
for (const auto &line : lines) {
if (handleSecret(line) == HandlingResult::Stop) {
break;
}
}
});
const auto error = decryptJob->start(file.readAll());
if (error) {
qCWarning(PLASMAPASS_LOG, "Failed to decrypt password: %s", error.asString());
setError(i18n("Failed to decrypt password: %1", QString::fromUtf8(error.asString())));
return;
}
}
bool ProviderBase::isValid() const
{
return !mSecret.isNull();
}
QString ProviderBase::secret() const
{
return mSecret;
}
namespace {
QMimeData *mimeDataForPassword(const QString &password)
{
auto mimeData = new QMimeData;
mimeData->setText(password);
// https://phabricator.kde.org/D12539
mimeData->setData(QStringLiteral("x-kde-passwordManagerHint"), "secret");
return mimeData;
}
} // namespace
void ProviderBase::setSecret(const QString &secret)
{
auto clipboard = qGuiApp->clipboard(); // NOLINT(cppcoreguidelines-pro-type-static-cast-downcast)
clipboard->setMimeData(mimeDataForPassword(secret), QClipboard::Clipboard);
if (clipboard->supportsSelection()) {
clipboard->setMimeData(mimeDataForPassword(secret), QClipboard::Selection);
}
mSecret = secret;
Q_EMIT validChanged();
Q_EMIT secretChanged();
mTimeout = defaultTimeout();
Q_EMIT timeoutChanged();
mTimer.start();
}
void ProviderBase::setSecretTimeout(std::chrono::seconds timeout)
{
mSecretTimeout = timeout;
}
void ProviderBase::expireSecret()
{
removePasswordFromClipboard(mSecret);
mSecret.clear();
mTimer.stop();
Q_EMIT validChanged();
Q_EMIT secretChanged();
// Delete the provider, it's no longer needed
deleteLater();
}
int ProviderBase::timeout() const
{
return mTimeout;
}
int ProviderBase::defaultTimeout() const
{
return duration_cast<milliseconds>(mSecretTimeout).count();
}
QString ProviderBase::error() const
{
return mError;
}
bool ProviderBase::hasError() const
{
return !mError.isNull();
}
void ProviderBase::setError(const QString &error)
{
mError = error;
Q_EMIT errorChanged();
}
void ProviderBase::reset()
{
mError.clear();
mSecret.clear();
mTimer.stop();
Q_EMIT errorChanged();
Q_EMIT validChanged();
Q_EMIT secretChanged();
QTimer::singleShot(0, this, &ProviderBase::start);
}
void ProviderBase::removePasswordFromClipboard(const QString &password)
{
// Clear the WS clipboard itself
const auto clipboard = qGuiApp->clipboard(); // NOLINT(cppcoreguidelines-pro-type-static-cast-downcast)
if (clipboard->text() == password) {
clipboard->clear();
}
if (sKlipperState == KlipperUtils::State::Unknown) {
sKlipperState = KlipperUtils::getState();
}
switch (sKlipperState) {
case KlipperUtils::State::Unknown:
case KlipperUtils::State::Missing:
qCDebug(PLASMAPASS_LOG, "Klipper not detected in the system, will not attempt to clear the clipboard history");
return;
case KlipperUtils::State::SupportsPasswordManagerHint:
// Klipper is not present in the system or is recent enough that it
// supports the x-kde-passwordManagerHint in which case we don't need to
// ask it to remove the password from its history - it would fail since the
// password is not there and we would end up clearing user's entire clipboard
// history.
qCDebug(PLASMAPASS_LOG, "Klipper with support for x-kde-passwordManagerHint detected, will not attempt to clear the clipboard history");
return;
case KlipperUtils::State::Available:
// Klipper is available but is too old to support x-kde-passwordManagerHint so
// we have to attempt to clear the password manually.
qCDebug(PLASMAPASS_LOG, "Old Klipper without x-kde-passwordManagerHint support detected, will attempt to remove the password from clipboard history");
break;
}
if (!mEngineConsumer) {
mEngineConsumer = std::make_unique<Plasma5Support::DataEngineConsumer>();
}
auto engine = mEngineConsumer->dataEngine(klipperDataEngine);
// Klipper internally identifies each history entry by its SHA1 hash
// (see klipper/historystringitem.cpp) so we try here to obtain a service directly
// for the history item with our password so that we can only remove the
// password from the history without having to clear the entire history.
const auto service = engine->serviceForSource(QString::fromLatin1(QCryptographicHash::hash(password.toUtf8(), QCryptographicHash::Sha1).toBase64()));
if (service == nullptr) {
qCWarning(PLASMAPASS_LOG, "Failed to obtain PlasmaService for the password, falling back to clearClipboard()");
mEngineConsumer.reset();
clearClipboard();
return;
}
auto job = service->startOperationCall(service->operationDescription(QStringLiteral("remove")));
connect(job, &KJob::result, this, &ProviderBase::onPlasmaServiceRemovePasswordResult);
}
void ProviderBase::onPlasmaServiceRemovePasswordResult(KJob *job)
{
// Disconnect from the job: Klipper's ClipboardJob is buggy and emits result() twice
disconnect(job, &KJob::result, this, &ProviderBase::onPlasmaServiceRemovePasswordResult);
QTimer::singleShot(0, this, [this]() {
mEngineConsumer.reset();
});
auto serviceJob = qobject_cast<Plasma5Support::ServiceJob *>(job);
if (serviceJob->error() != 0) {
qCWarning(PLASMAPASS_LOG, "ServiceJob for clipboard failed: %s", qUtf8Printable(serviceJob->errorString()));
clearClipboard();
return;
}
// If something went wrong fallback to clearing the entire clipboard
if (!serviceJob->result().toBool()) {
qCWarning(PLASMAPASS_LOG, "ServiceJob for clipboard failed internally, falling back to clearClipboard()");
clearClipboard();
return;
}
qCDebug(PLASMAPASS_LOG, "Successfully removed password from Klipper");
}
void ProviderBase::clearClipboard()
{
org::kde::klipper::klipper klipper(klipperDBusService, klipperDBusPath, QDBusConnection::sessionBus());
if (!klipper.isValid()) {
return;
}
klipper.clearClipboardHistory();
klipper.clearClipboardContents();
}
#include "moc_providerbase.cpp"
|