/* This file is part of the KDE libraries SPDX-FileCopyrightText: 2002-2004 George Staikos SPDX-FileCopyrightText: 2008 Michael Leupold SPDX-License-Identifier: LGPL-2.0-or-later */ #ifndef _KWALLETD_H_ #define _KWALLETD_H_ #include "kwalletbackend.h" #include #include #include #include #include #include #include "ktimeout.h" #include "kwalletsessionstore.h" class KDirWatch; class KTimeout; // @Private class KWalletTransaction; class KWalletSessionStore; class KWalletFreedesktopService; class KWalletD : public QObject, protected QDBusContext { Q_OBJECT public: KWalletD(); ~KWalletD() override; static QString encodeWalletName(const QString &name); static QString decodeWalletName(const QString &mangledName); int nextTransactionId() const; int openAsync(const QString &wallet, qlonglong wId, const QString &appid, bool handleSession, const QDBusConnection &connection, const QDBusMessage &message); // Close and lock the wallet // Accepts "message" for working from other QDBusContexts int close(int handle, bool force, const QString &appid, const QDBusMessage &message); public Q_SLOTS: // Is the wallet enabled? If not, all open() calls fail. bool isEnabled() const; // Open and unlock the wallet int open(const QString &wallet, qlonglong wId, const QString &appid); // Open and unlock the wallet with this path int openPath(const QString &path, qlonglong wId, const QString &appid); // Open the wallet asynchronously int openAsync(const QString &wallet, qlonglong wId, const QString &appid, bool handleSession); // Open and unlock the wallet with this path asynchronously int openPathAsync(const QString &path, qlonglong wId, const QString &appid, bool handleSession); // Close and lock the wallet // If force = true, will close it for all users. Behave. This // can break applications, and is generally intended for use by // the wallet manager app only. int close(const QString &wallet, bool force); int close(int handle, bool force, const QString &appid); // Save to disk but leave open Q_NOREPLY void sync(int handle, const QString &appid); // Physically deletes the wallet from disk. int deleteWallet(const QString &wallet); // Returns true if the wallet is open bool isOpen(const QString &wallet); bool isOpen(int handle); // List the users of this wallet QStringList users(const QString &wallet) const; // Change the password of this wallet void changePassword(const QString &wallet, qlonglong wId, const QString &appid); // A list of all wallets QStringList wallets() const; // A list of all folders in this wallet QStringList folderList(int handle, const QString &appid); // Does this wallet have this folder? bool hasFolder(int handle, const QString &folder, const QString &appid); // Create this folder bool createFolder(int handle, const QString &folder, const QString &appid); // Remove this folder bool removeFolder(int handle, const QString &folder, const QString &appid); // List of entries in this folder QStringList entryList(int handle, const QString &folder, const QString &appid); // Read an entry. If the entry does not exist, it just // returns an empty result. It is your responsibility to check // hasEntry() first. QByteArray readEntry(int handle, const QString &folder, const QString &key, const QString &appid); QByteArray readMap(int handle, const QString &folder, const QString &key, const QString &appid); QString readPassword(int handle, const QString &folder, const QString &key, const QString &appid); #if KWALLET_BUILD_DEPRECATED_SINCE(5, 72) // use entriesList() QVariantMap readEntryList(int handle, const QString &folder, const QString &key, const QString &appid); #endif #if KWALLET_BUILD_DEPRECATED_SINCE(5, 72) // use mapList() QVariantMap readMapList(int handle, const QString &folder, const QString &key, const QString &appid); #endif #if KWALLET_BUILD_DEPRECATED_SINCE(5, 72) // use passwordList() QVariantMap readPasswordList(int handle, const QString &folder, const QString &key, const QString &appid); #endif QVariantMap entriesList(int handle, const QString &folder, const QString &appid); QVariantMap mapList(int handle, const QString &folder, const QString &appid); QVariantMap passwordList(int handle, const QString &folder, const QString &appid); // Rename an entry. rc=0 on success. int renameEntry(int handle, const QString &folder, const QString &oldName, const QString &newName, const QString &appid); // Rename the wallet int renameWallet(const QString &oldName, const QString &newName); // Write an entry. rc=0 on success. int writeEntry(int handle, const QString &folder, const QString &key, const QByteArray &value, int entryType, const QString &appid); int writeEntry(int handle, const QString &folder, const QString &key, const QByteArray &value, const QString &appid); int writeMap(int handle, const QString &folder, const QString &key, const QByteArray &value, const QString &appid); int writePassword(int handle, const QString &folder, const QString &key, const QString &value, const QString &appid); // Does the entry exist? bool hasEntry(int handle, const QString &folder, const QString &key, const QString &appid); // What type is the entry? int entryType(int handle, const QString &folder, const QString &key, const QString &appid); // Remove an entry. rc=0 on success. int removeEntry(int handle, const QString &folder, const QString &key, const QString &appid); // Disconnect an app from a wallet bool disconnectApplication(const QString &wallet, const QString &application); void reconfigure(); // Determine bool folderDoesNotExist(const QString &wallet, const QString &folder); bool keyDoesNotExist(const QString &wallet, const QString &folder, const QString &key); void closeAllWallets(); QString networkWallet(); QString localWallet(); void screenSaverChanged(bool); // Open a wallet using a pre-hashed password. This is only useful in cooperation // with the kwallet PAM module. It's also less secure than manually entering the // password as the password hash is transmitted using D-Bus. int pamOpen(const QString &wallet, const QByteArray &passwordHash, int sessionTimeout); Q_SIGNALS: void walletAsyncOpened(int id, int handle); // used to notify KWallet::Wallet void walletListDirty(); void walletCreated(const QString &wallet); void walletOpened(const QString &wallet); void walletDeleted(const QString &wallet); void walletClosed(const QString &wallet); // clazy:exclude=overloaded-signal // TODO KF6 remove this signal, replaced by walletClosedId(int) void walletClosed(int handle); // clazy:exclude=overloaded-signal // since 5.81 void walletClosedId(int handle); void allWalletsClosed(); void folderListUpdated(const QString &wallet); void folderUpdated(const QString &, const QString &); void entryUpdated(const QString &, const QString &, const QString &); void entryRenamed(const QString &, const QString &, const QString &, const QString &); void entryDeleted(const QString &, const QString &, const QString &); void applicationDisconnected(const QString &wallet, const QString &application); private Q_SLOTS: void slotServiceOwnerChanged(const QString &name, const QString &oldOwner, const QString &newOwner); void emitWalletListDirty(); void timedOutClose(int handle); void timedOutSync(int handle); void notifyFailures(); void processTransactions(); void activatePasswordDialog(); #ifdef Q_WS_X11 void connectToScreenSaver(); #endif private: // Internal - open a wallet int internalOpen(const QString &appid, const QString &wallet, bool isPath, WId w, bool modal, const QString &service); // Internal - close this wallet. int internalClose(KWallet::Backend *const w, const int handle, const bool force, const bool saveBeforeClose = true); bool isAuthorizedApp(const QString &appid, const QString &wallet, WId w); // This also validates the handle. May return NULL. KWallet::Backend *getWallet(const QString &appid, int handle); // Generate a new unique handle. int generateHandle(); // Emit signals about closing wallets void doCloseSignals(int, const QString &); void emitFolderUpdated(const QString &, const QString &); void emitEntryUpdated(const QString &, const QString &, const QString &); void emitEntryRenamed(const QString &, const QString &, const QString &, const QString &); void emitEntryDeleted(const QString &, const QString &, const QString &); // Implicitly allow access for this application bool implicitAllow(const QString &wallet, const QString &app); bool implicitDeny(const QString &wallet, const QString &app); void doTransactionChangePassword(const QString &appid, const QString &wallet, qlonglong wId); void doTransactionOpenCancelled(const QString &appid, const QString &wallet, const QString &service); int doTransactionOpen(const QString &appid, const QString &wallet, bool isPath, qlonglong wId, bool modal, const QString &service); void initiateSync(int handle); void setupDialog(QWidget *dialog, WId wId, const QString &appid, bool modal); void checkActiveDialog(); QPair findWallet(const QString &walletName) const; typedef QHash Wallets; Wallets _wallets; KDirWatch *_dw; int _failed; // configuration values bool _leaveOpen, _closeIdle, _launchManager, _enabled; bool _openPrompt, _firstUse, _showingFailureNotify; int _idleTime; QMap _implicitAllowMap, _implicitDenyMap; KTimeout _closeTimers; KTimeout _syncTimers; const int _syncTime; static bool _processing; KWalletTransaction *_curtrans; // current transaction QList _transactions; QPointer activeDialog; #ifdef Q_WS_X11 QDBusInterface *screensaver; #endif // sessions KWalletSessionStore _sessions; QDBusServiceWatcher _serviceWatcher; std::unique_ptr _fdoService; bool _useGpg; }; #endif