QtPass 1.6.0
Multi-platform GUI for pass, the standard unix password manager.
Loading...
Searching...
No Matches
qtpass.cpp
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2018 Anne Jan Brouwer
2// SPDX-License-Identifier: GPL-3.0-or-later
3#include "qtpass.h"
4#include "mainwindow.h"
5#include "qtpasssettings.h"
6#include "util.h"
7#include <QApplication>
8#include <QClipboard>
9#include <QDialog>
10#include <QLabel>
11#include <QPixmap>
12#include <QVBoxLayout>
13
14#ifndef Q_OS_WIN
15#include <QInputDialog>
16#include <QLineEdit>
17#include <QMimeData>
18#include <utility>
19#else
20#define WIN32_LEAN_AND_MEAN /*_KILLING_MACHINE*/
21#define WIN32_EXTRA_LEAN
22#include <windows.h>
23#include <winnetwk.h>
24#undef DELETE
25#include <QMimeData>
26#endif
27
28#ifdef QT_DEBUG
29#include "debughelper.h"
30#endif
31
37 : m_mainWindow(mainWindow), freshStart(true) {
39 clearClipboardTimer.setSingleShot(true);
40 connect(&clearClipboardTimer, &QTimer::timeout, this,
42
43#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
44#pragma GCC diagnostic push
45#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
46#endif
47 QObject::connect(qApp, &QApplication::aboutToQuit, this,
49#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
50#pragma GCC diagnostic pop
51#endif
52
53 setMainWindow();
54}
55
60#ifdef Q_OS_WIN
62 WNetCancelConnection2A(QtPassSettings::getPassStore().toUtf8().constData(),
63 0, 1);
64#else
65 if (fusedav.state() == QProcess::Running) {
66 fusedav.terminate();
67 fusedav.waitForFinished(2000);
68 }
69#endif
70}
71
76auto QtPass::init() -> bool {
79
81
82 QString version = QtPassSettings::getVersion();
83
84 // Config updates
85 if (version.isEmpty()) {
86#ifdef QT_DEBUG
87 dbg() << "assuming fresh install";
88#endif
89
92 }
95 }
96 if (!QtPassSettings::getPwgenExecutable().isEmpty()) {
98 } else {
100 }
102 } else {
103 if (QtPassSettings::getPassTemplate().isEmpty()) {
105 }
106 }
107
109
110 if (!Util::configIsValid()) {
111 m_mainWindow->config();
112 if (freshStart && !Util::configIsValid()) {
113 return false;
114 }
115 }
116
117 // Note: WebDAV mount needs to happen before accessing the store,
118 // but ideally should be done after Window is shown to avoid long delay.
120 mountWebDav();
121 }
122
123 freshStart = false;
124 return true;
125}
126
130void QtPass::setMainWindow() {
131 m_mainWindow->restoreWindow();
132
133 fusedav.setParent(m_mainWindow);
134
135 // Signal handlers are connected for both pass implementations
136 // Note: When pass binary changes, QtPass restart is required to reconnect
137 // This is acceptable as pass binary change is infrequent
138 connectPassSignalHandlers(QtPassSettings::getRealPass());
139 connectPassSignalHandlers(QtPassSettings::getImitatePass());
140
141 connect(m_mainWindow, &MainWindow::passShowHandlerFinished, this,
142 &QtPass::passShowHandlerFinished);
143
144 // only for ipass
146 m_mainWindow, &MainWindow::startReencryptPath);
148 m_mainWindow, &MainWindow::endReencryptPath);
149
150 connect(m_mainWindow, &MainWindow::passGitInitNeeded, [this]() {
151#ifdef QT_DEBUG
152 dbg() << "Pass git init called";
153#endif
154 QtPassSettings::getPass()->GitInit();
155 });
156
157 connect(m_mainWindow, &MainWindow::generateGPGKeyPair, m_mainWindow,
158 [this](const QString &batch) {
159 QtPassSettings::getPass()->GenerateGPGKeys(batch);
160 m_mainWindow->showStatusMessage(tr("Generating GPG key pair"),
161 60000);
162 });
163}
164
169void QtPass::connectPassSignalHandlers(Pass *pass) {
170 connect(pass, &Pass::error, this, &QtPass::processError);
171 connect(pass, &Pass::processErrorExit, this, &QtPass::processErrorExit);
172 connect(pass, &Pass::critical, m_mainWindow, &MainWindow::critical);
173 connect(pass, &Pass::startingExecuteWrapper, m_mainWindow,
175 connect(pass, &Pass::statusMsg, m_mainWindow, &MainWindow::showStatusMessage);
176 connect(pass, &Pass::finishedShow, m_mainWindow,
178 connect(pass, &Pass::finishedOtpGenerate, m_mainWindow,
180
181 connect(pass, &Pass::finishedGitInit, this, &QtPass::passStoreChanged);
182 connect(pass, &Pass::finishedGitPull, this, &QtPass::processFinished);
183 connect(pass, &Pass::finishedGitPush, this, &QtPass::processFinished);
184 connect(pass, &Pass::finishedInsert, this, &QtPass::finishedInsert);
185 connect(pass, &Pass::finishedRemove, this, &QtPass::passStoreChanged);
186 connect(pass, &Pass::finishedInit, this, &QtPass::passStoreChanged);
187 connect(pass, &Pass::finishedMove, this, &QtPass::passStoreChanged);
188 connect(pass, &Pass::finishedCopy, this, &QtPass::passStoreChanged);
189 connect(pass, &Pass::finishedGenerateGPGKeys, this,
190 &QtPass::onKeyGenerationComplete);
191}
192
196void QtPass::mountWebDav() {
197#ifdef Q_OS_WIN
198 char dst[20] = {0};
199 NETRESOURCEA netres;
200 memset(&netres, 0, sizeof(netres));
201 netres.dwType = RESOURCETYPE_DISK;
202 netres.lpLocalName = nullptr;
203 // Store QByteArray in variables to ensure lifetime during WNetUseConnectionA
204 // call
205 QByteArray webDavUrlUtf8 = QtPassSettings::getWebDavUrl().toUtf8();
206 QByteArray webDavPasswordUtf8 = QtPassSettings::getWebDavPassword().toUtf8();
207 QByteArray webDavUserUtf8 = QtPassSettings::getWebDavUser().toUtf8();
208 netres.lpRemoteName = const_cast<char *>(webDavUrlUtf8.constData());
209 DWORD size = sizeof(dst);
210 DWORD r = WNetUseConnectionA(
211 reinterpret_cast<HWND>(m_mainWindow->effectiveWinId()), &netres,
212 const_cast<char *>(webDavPasswordUtf8.constData()),
213 const_cast<char *>(webDavUserUtf8.constData()),
214 CONNECT_TEMPORARY | CONNECT_INTERACTIVE | CONNECT_REDIRECT, dst, &size,
215 0);
216 if (r == NO_ERROR) {
218 } else {
219 char message[256] = {0};
220 FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM, 0, r, 0, message,
221 sizeof(message), 0);
222 m_mainWindow->flashText(tr("Failed to connect WebDAV:\n") + message +
223 " (0x" + QString::number(r, 16) + ")",
224 true);
225 }
226#else
227 fusedav.start("fusedav", QStringList()
228 << "-o"
229 << "nonempty"
230 << "-u"
231 << "\"" + QtPassSettings::getWebDavUser() + "\""
233 << "\"" + QtPassSettings::getPassStore() + "\"");
234 fusedav.waitForStarted();
235 if (fusedav.state() == QProcess::Running) {
236 QString pwd = QtPassSettings::getWebDavPassword();
237 bool ok = true;
238 if (pwd.isEmpty()) {
239 pwd = QInputDialog::getText(m_mainWindow, tr("QtPass WebDAV password"),
240 tr("Enter password to connect to WebDAV:"),
241 QLineEdit::Password, "", &ok);
242 }
243 if (ok && !pwd.isEmpty()) {
244 fusedav.write(pwd.toUtf8() + '\n');
245 fusedav.closeWriteChannel();
246 fusedav.waitForFinished(2000);
247 } else {
248 fusedav.terminate();
249 }
250 }
251 QString error = fusedav.readAllStandardError();
252 int prompt = error.indexOf("Password:");
253 if (prompt >= 0) {
254 error.remove(0, prompt + 10);
255 }
256 if (fusedav.state() != QProcess::Running) {
257 error = tr("fusedav exited unexpectedly\n") + error;
258 }
259 if (error.size() > 0) {
260 m_mainWindow->flashText(
261 tr("Failed to start fusedav to connect WebDAV:\n") + error, true);
262 }
263#endif
264}
265
270void QtPass::processError(QProcess::ProcessError error) {
271 QString errorString;
272 switch (error) {
273 case QProcess::FailedToStart:
274 errorString = tr("QProcess::FailedToStart");
275 break;
276 case QProcess::Crashed:
277 errorString = tr("QProcess::Crashed");
278 break;
279 case QProcess::Timedout:
280 errorString = tr("QProcess::Timedout");
281 break;
282 case QProcess::ReadError:
283 errorString = tr("QProcess::ReadError");
284 break;
285 case QProcess::WriteError:
286 errorString = tr("QProcess::WriteError");
287 break;
288 case QProcess::UnknownError:
289 errorString = tr("QProcess::UnknownError");
290 break;
291 }
292 m_mainWindow->flashText(errorString, true);
293 m_mainWindow->setUiElementsEnabled(true);
294}
295
301void QtPass::processErrorExit(int exitCode, const QString &p_error) {
302 if (nullptr != m_mainWindow->getKeygenDialog()) {
303 m_mainWindow->cleanKeygenDialog();
304 if (exitCode != 0) {
305 m_mainWindow->showStatusMessage(tr("GPG key pair generation failed"),
306 10000);
307 }
308 }
309
310 if (!p_error.isEmpty()) {
311 QString output;
312 QString error = p_error.toHtmlEscaped();
313 if (exitCode == 0) {
314 // https://github.com/IJHack/qtpass/issues/111
315 output = "<span style=\"color: darkgray;\">" + error + "</span><br />";
316 } else {
317 output = "<span style=\"color: red;\">" + error + "</span><br />";
318 }
319
320 output.replace(Util::protocolRegex(), R"(<a href="\1">\1</a>)");
321 output.replace(QStringLiteral("\n"), "<br />");
322
323 m_mainWindow->flashText(output, false, true);
324 }
325
326 m_mainWindow->setUiElementsEnabled(true);
327}
328
336void QtPass::processFinished(const QString &p_output, const QString &p_errout) {
337 showInTextBrowser(p_output);
338 // Sometimes there is error output even with 0 exit code, which is
339 // assumed in this function
340 processErrorExit(0, p_errout);
341
342 m_mainWindow->setUiElementsEnabled(true);
343}
344
350void QtPass::passStoreChanged(const QString &p_out, const QString &p_err) {
351 processFinished(p_out, p_err);
352 doGitPush();
353}
354
360void QtPass::finishedInsert(const QString &p_output, const QString &p_errout) {
361 processFinished(p_output, p_errout);
362 doGitPush();
363 m_mainWindow->on_treeView_clicked(m_mainWindow->getCurrentTreeViewIndex());
364}
365
371void QtPass::onKeyGenerationComplete(const QString &p_output,
372 const QString &p_errout) {
373 if (nullptr != m_mainWindow->getKeygenDialog()) {
374#ifdef QT_DEBUG
375 qDebug() << "Keygen Done";
376#endif
377
378 m_mainWindow->cleanKeygenDialog();
379 m_mainWindow->showStatusMessage(tr("GPG key pair generated successfully"),
380 10000);
381 }
382
383 processFinished(p_output, p_errout);
384}
385
390void QtPass::passShowHandlerFinished(QString output) {
391 showInTextBrowser(std::move(output));
392}
393
400void QtPass::showInTextBrowser(QString output, const QString &prefix,
401 const QString &postfix) {
402 output = output.toHtmlEscaped();
403
404 output.replace(Util::protocolRegex(), R"(<a href="\1">\1</a>)");
405 output.replace(QStringLiteral("\n"), "<br />");
406 output = prefix + output + postfix;
407
408 m_mainWindow->flashText(output, false, true);
409}
410
414void QtPass::doGitPush() {
416 m_mainWindow->onPush();
417 }
418}
419
426void QtPass::setClippedText(const QString &password, const QString &p_output) {
428 !p_output.isEmpty()) {
429 clippedText = password;
431 copyTextToClipboard(password);
432 }
433 }
434}
435
438void QtPass::clearClippedText() { clippedText = ""; }
439
444 clearClipboardTimer.setInterval(MS_PER_SECOND *
446}
447
452 QClipboard *clipboard = QApplication::clipboard();
453 bool cleared = false;
454 if (this->clippedText == clipboard->text(QClipboard::Selection)) {
455 clipboard->clear(QClipboard::Selection);
456 clipboard->setText(QString(""), QClipboard::Selection);
457 cleared = true;
458 }
459 if (this->clippedText == clipboard->text(QClipboard::Clipboard)) {
460 clipboard->clear(QClipboard::Clipboard);
461 cleared = true;
462 }
463 if (cleared) {
464 m_mainWindow->showStatusMessage(tr("Clipboard cleared"));
465 } else {
466 m_mainWindow->showStatusMessage(tr("Clipboard not cleared"));
467 }
468
469 clippedText.clear();
470}
471
477auto buildClipboardMimeData(const QString &text) -> QMimeData * {
478 auto *mimeData = new QMimeData();
479 mimeData->setText(text);
480#ifdef Q_OS_LINUX
481 mimeData->setData("x-kde-passwordManagerHint", QByteArray("secret"));
482#endif
483#ifdef Q_OS_MAC
484 mimeData->setData("application/x-nspasteboard-concealed-type", QByteArray());
485#endif
486#ifdef Q_OS_WIN
487 mimeData->setData("ExcludeClipboardContentFromMonitorProcessing",
488 dwordBytes(1));
489 mimeData->setData("CanIncludeInClipboardHistory", dwordBytes(0));
490 mimeData->setData("CanUploadToCloudClipboard", dwordBytes(0));
491#endif
492 return mimeData;
493}
494
499void QtPass::copyTextToClipboard(const QString &text) {
500 QClipboard *clip = QApplication::clipboard();
501
502 QClipboard::Mode mode = QClipboard::Clipboard;
503 if (QtPassSettings::isUseSelection() && clip->supportsSelection()) {
504 mode = QClipboard::Selection;
505 }
506
507 auto *mimeData = buildClipboardMimeData(text);
508 clip->setMimeData(mimeData, mode);
509
510 clippedText = text;
511 m_mainWindow->showStatusMessage(tr("Copied to clipboard"));
513 clearClipboardTimer.start();
514 }
515}
516
521void QtPass::showTextAsQRCode(const QString &text) {
522 QProcess qrencode;
523 qrencode.start(QtPassSettings::getQrencodeExecutable("/usr/bin/qrencode"),
524 QStringList() << "-o-"
525 << "-tPNG");
526 qrencode.write(text.toUtf8());
527 qrencode.closeWriteChannel();
528 qrencode.waitForFinished();
529 QByteArray output(qrencode.readAllStandardOutput());
530
531 if (qrencode.exitStatus() || qrencode.exitCode()) {
532 QString error(qrencode.readAllStandardError());
533 m_mainWindow->showStatusMessage(error);
534 } else {
535 QPixmap image;
536 image.loadFromData(output, "PNG");
537 QDialog *popup = createQRCodePopup(image);
538 popup->exec();
539 }
540}
541
549QDialog *QtPass::createQRCodePopup(const QPixmap &image) {
550 auto *popup = new QDialog(nullptr, Qt::Popup | Qt::FramelessWindowHint);
551 popup->setAttribute(Qt::WA_DeleteOnClose);
552 auto *layout = new QVBoxLayout;
553 auto *popupLabel = new QLabel();
554 layout->addWidget(popupLabel);
555 popupLabel->setPixmap(image);
556 popupLabel->setScaledContents(true);
557 popupLabel->show();
558 popup->setLayout(layout);
559 popup->move(QCursor::pos());
560 return popup;
561}
void endReencryptPath()
Emitted after finishing re-encryption.
void startReencryptPath()
Emitted before starting re-encryption.
The MainWindow class does way too much, not only is it a switchboard, configuration handler and more,...
Definition mainwindow.h:51
void startReencryptPath()
MainWindow::startReencryptPath disable ui elements and treeview.
void passShowHandler(const QString &)
void endReencryptPath()
MainWindow::endReencryptPath re-enable ui elements.
void executeWrapperStarted()
void passGitInitNeeded()
void critical(const QString &, const QString &)
MainWindow::critical critical message popup wrapper.
void showStatusMessage(const QString &msg, int timeout=2000)
Displays message in status bar.
void passOtpHandler(const QString &)
void passShowHandlerFinished(const QString &output)
void generateGPGKeyPair(const QString &batch)
void restoreWindow()
Abstract base class for password store operations.
Definition pass.h:35
void startingExecuteWrapper()
Emitted before executing a command.
void critical(const QString &, const QString &)
Emit critical error.
void finishedCopy(const QString &, const QString &)
Emitted when copy finishes.
void finishedShow(const QString &)
Emitted when show finishes.
void finishedRemove(const QString &, const QString &)
Emitted when remove finishes.
void finishedMove(const QString &, const QString &)
Emitted when move finishes.
void statusMsg(const QString &, int)
Emit status message.
void finishedGitInit(const QString &, const QString &)
Emitted when Git init finishes.
void finishedInsert(const QString &, const QString &)
Emitted when insert finishes.
void finishedInit(const QString &, const QString &)
Emitted when init finishes.
void finishedOtpGenerate(const QString &)
Emitted when OTP generation finishes.
void processErrorExit(int exitCode, const QString &err)
Emitted on process error exit.
void finishedGitPull(const QString &, const QString &)
Emitted when Git pull finishes.
void finishedGitPush(const QString &, const QString &)
Emitted when Git push finishes.
void error(QProcess::ProcessError)
Emitted when a process error occurs.
void finishedGenerateGPGKeys(const QString &, const QString &)
Emitted when GPG key generation finishes.
void clearClippedText()
Clears the stored clipped text.
Definition qtpass.cpp:438
void setClipboardTimer()
Sets the clipboard clear timer based on autoclear settings.
Definition qtpass.cpp:443
void clearClipboard()
MainWindow::clearClipboard remove clipboard contents.
Definition qtpass.cpp:451
~QtPass()
QtPass::~QtPass destroy!
Definition qtpass.cpp:59
void setClippedText(const QString &, const QString &p_output=QString())
Sets the text to be stored in clipboard and handles clipboard operations.
Definition qtpass.cpp:426
QtPass(MainWindow *mainWindow)
Constructs a QtPass instance.
Definition qtpass.cpp:36
static QDialog * createQRCodePopup(const QPixmap &image)
QtPass::createQRCodePopup creates a popup dialog with the given QR code image. This is extracted for ...
Definition qtpass.cpp:549
void copyTextToClipboard(const QString &text)
MainWindow::copyTextToClipboard copies text to your clipboard.
Definition qtpass.cpp:499
auto init() -> bool
QtPass::init make sure we are ready to go as soon as possible.
Definition qtpass.cpp:76
void showTextAsQRCode(const QString &text)
displays the text as qrcode
Definition qtpass.cpp:521
static auto isUseSelection(const bool &defaultValue=QVariant().toBool()) -> bool
Get whether to use selection (X11) for clipboard.
static auto isUseAutoclear(const bool &defaultValue=QVariant().toBool()) -> bool
Get whether to use autoclear for clipboard.
static void setAutoclearPanelSeconds(const int &autoClearPanelSeconds)
Save panel autoclear seconds.
static auto getWebDavPassword(const QString &defaultValue=QVariant().toString()) -> QString
Get WebDAV password.
static auto getPwgenExecutable(const QString &defaultValue=QVariant().toString()) -> QString
Get pwgen executable path.
static auto getWebDavUser(const QString &defaultValue=QVariant().toString()) -> QString
Get WebDAV username.
static void setPassStore(const QString &passStore)
Save password store path.
static auto getPass() -> Pass *
Get currently active pass backend instance.
static auto getClipBoardType(const Enums::clipBoardType &defaultValue=Enums::CLIPBOARD_NEVER) -> Enums::clipBoardType
Get clipboard type as enum.
static void setUsePwgen(const bool &usePwgen)
Save pwgen support flag.
static auto getPassStore(const QString &defaultValue=QVariant().toString()) -> QString
Get password store directory path.
static auto getVersion(const QString &defaultValue=QVariant().toString()) -> QString
Get saved application version.
static void initExecutables()
Initialize executable paths by auto-detecting them.
static void setPassTemplate(const QString &passTemplate)
Save pass entry template.
static auto getQrencodeExecutable(const QString &defaultValue=QVariant().toString()) -> QString
Get qrencode executable path.
static void setVersion(const QString &version)
Save application version.
static auto getRealPass() -> RealPass *
Get real pass backend instance.
static auto getPassTemplate(const QString &defaultValue=QVariant().toString()) -> QString
Get pass entry template.
static auto getWebDavUrl(const QString &defaultValue=QVariant().toString()) -> QString
Get WebDAV URL.
static auto isUseWebDav(const bool &defaultValue=QVariant().toBool()) -> bool
Check whether WebDAV integration is enabled.
static auto getAutoclearPanelSeconds(const int &defaultValue=QVariant().toInt()) -> int
Get panel autoclear delay in seconds.
static void setAutoclearSeconds(const int &autoClearSeconds)
Save autoclear seconds.
static auto getImitatePass() -> ImitatePass *
Get imitate pass backend instance.
static auto getAutoclearSeconds(const int &defaultValue=QVariant().toInt()) -> int
Get autoclear delay in seconds.
static auto isAutoPush(const bool &defaultValue=QVariant().toBool()) -> bool
Check whether automatic push is enabled.
static auto protocolRegex() -> const QRegularExpression &
Returns a regex to match URL protocols.
Definition util.cpp:266
static auto findPasswordStore() -> QString
Locate the password store directory.
Definition util.cpp:77
static auto configIsValid() -> bool
Verify that the required configuration is complete.
Definition util.cpp:188
Debug utilities for QtPass.
#define dbg()
Simple debug macro that includes file and line number.
Definition debughelper.h:21
@ CLIPBOARD_ALWAYS
Definition enums.h:18
@ CLIPBOARD_NEVER
Definition enums.h:17
auto buildClipboardMimeData(const QString &text) -> QMimeData *
Build clipboard MIME data with platform-specific security hints.
Definition qtpass.cpp:477
auto buildClipboardMimeData(const QString &text) -> QMimeData *
Build clipboard MIME data with platform-specific security hints.
Definition qtpass.cpp:477
constexpr int MS_PER_SECOND
Definition util.h:12