mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-23 18:32:49 +00:00
120 lines
3.9 KiB
C++
120 lines
3.9 KiB
C++
/* This file is part of the KDE libraries
|
|
Copyright (C) 2022 Ivailo Monev <xakepa10@gmail.com>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License version 2, as published by the Free Software Foundation.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef KPASSWDSTORE_H
|
|
#define KPASSWDSTORE_H
|
|
|
|
#include "kpasswdstore_export.h"
|
|
|
|
#include <QObject>
|
|
|
|
class KPasswdStorePrivate;
|
|
|
|
/*!
|
|
Class to store and retrieve passwords.
|
|
|
|
The password used for encrypting and decrypting the store will be asked for
|
|
upon the first request and again after 2 minutes of inactivity. Opening the
|
|
store pre-emptively is also possbile but optional.
|
|
|
|
@code
|
|
KPasswdStore kpasswdstore;
|
|
kpasswdstore.setStoreID("myid");
|
|
if (kpasswdstore.openStore()) {
|
|
qDebug() << kpasswdstore.storePasswd("mykey", "mypass");
|
|
qDebug() << kpasswdstore.getPasswd("mykey");
|
|
} else {
|
|
qWarning() << "could not open store";
|
|
}
|
|
@endcode
|
|
|
|
Unlike KWallet the password stores do not use master password (for the
|
|
commonly used network and local wallets) - each store has its own password
|
|
and if password for one store is compromised the other stores will not be
|
|
affected, unless the same password is used for multiple stores. Note that
|
|
this is left up to the user - using the same password for multiple password
|
|
stores is absolutely possible.
|
|
|
|
@since 4.21
|
|
@note there are some type of changes and additions I will intentionally not
|
|
make nor will I accept patches for
|
|
*/
|
|
class KPASSWDSTORE_EXPORT KPasswdStore : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
/*!
|
|
@brief Contructs object with @p parent
|
|
*/
|
|
KPasswdStore(QObject *parent = nullptr);
|
|
~KPasswdStore();
|
|
|
|
/*!
|
|
@brief Sets the store ID to @p id
|
|
@note The ID is @p QApplication::applicationName() by default
|
|
*/
|
|
void setStoreID(const QString &id);
|
|
|
|
/*!
|
|
@brief Opens the store by asking for the password for it and returns
|
|
@p true if the store is open, @p false otherwise
|
|
*/
|
|
bool openStore(const qlonglong windowid = 0);
|
|
|
|
/*!
|
|
@brief If @p cacheonly is @p true then no permanent storage is used and
|
|
passwords store is discarded when the object is destroyed. Whenever
|
|
called the cache is also cleared
|
|
@note Caching only is disabled by default
|
|
*/
|
|
void setCacheOnly(const bool cacheonly);
|
|
/*!
|
|
@brief Returns @p true if passwords are cached only, @p false otherwise
|
|
*/
|
|
bool cacheOnly() const;
|
|
|
|
/*!
|
|
@brief Returns @p true if there is password for the given @p key in the
|
|
password store, @p false otherwise
|
|
*/
|
|
bool hasPasswd(const QByteArray &key, const qlonglong windowid = 0);
|
|
/*!
|
|
@brief Retrieves password for the given @p key from the password store
|
|
*/
|
|
QString getPasswd(const QByteArray &key, const qlonglong windowid = 0);
|
|
/*!
|
|
@brief Stores @p passwd with the given @p key in the password store
|
|
*/
|
|
bool storePasswd(const QByteArray &key, const QString &passwd, const qlonglong windowid = 0);
|
|
|
|
/*!
|
|
@brief Returns unique key for @p string for use with @p getPasswd() and @p storePasswd()
|
|
*/
|
|
static QByteArray makeKey(const QString &string);
|
|
|
|
/*!
|
|
@brief Returns all current password stores
|
|
*/
|
|
static QStringList stores();
|
|
|
|
private:
|
|
Q_DISABLE_COPY(KPasswdStore);
|
|
KPasswdStorePrivate *const d;
|
|
};
|
|
|
|
#endif // KPASSWDSTORE_H
|