AnotherFoxGuy/fuel-scm
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

⬆️ Update qtkeychain

Browse Source
This commit is contained in:
Edgar
2021-05-30 13:37:40 +02:00
parent a1b4487b1e
commit 078164838e
63 changed files with 6375 additions and 3445 deletions
Download Patch File Download Diff File Expand all files Collapse all files

202
ext/qtkeychain/keychain.h
View File

@@ -9,7 +9,11 @@
#ifndef KEYCHAIN_H
#define KEYCHAIN_H
#if !defined(QTKEYCHAIN_NO_EXPORT)
#include "qkeychain_export.h"
#else
#define QKEYCHAIN_EXPORT
#endif
#include <QtCore/QObject>
#include <QtCore/QString>
@@ -37,107 +41,229 @@ enum Error {
class JobExecutor;
class JobPrivate;
/**
* @brief Abstract base class for all QKeychain jobs.
*/
class QKEYCHAIN_EXPORT Job : public QObject {
Q_OBJECT
public:
explicit Job( const QString& service, QObject* parent=0 );
~Job();
~Job() override;
/**
* @return The QSettings instance used as plaintext storage if insecureFallback() is true.
* @see setSettings()
* @see insecureFallback()
*/
QSettings* settings() const;
/**
* @return Set the QSettings instance that will be used as plaintext storage if insecureFallback() is true.
* @see settings()
* @see insecureFallback()
*/
void setSettings( QSettings* settings );
/**
* Call this method to start the job.
* Typically you want to connect some slot to the finished() signal first:
*
* \code
* SomeClass::startJob()
* {
* connect(job, &Job::finished, this, &SomeClass::slotJobFinished);
* job->start();
* }
*
* SomeClass::slotJobFinished(Job *job)
* {
* if (job->error()) {
* // handle error
* } else {
* // do job-specific stuff
* }
* }
* \endcode
*
* @see finished()
*/
void start();
QString service() const;
/**
* @note Call this method only after finished() has been emitted.
* @return The error code of the job (0 if no error).
*/
Error error() const;
/**
* @return An error message that might provide details if error() returns OtherError.
*/
QString errorString() const;
/**
* @return Whether this job autodeletes itself once finished() has been emitted. Default is true.
* @see setAutoDelete()
*/
bool autoDelete() const;
/**
* Set whether this job should autodelete itself once finished() has been emitted.
* @see autoDelete()
*/
void setAutoDelete( bool autoDelete );
/**
* @return Whether this job will use plaintext storage on unsupported platforms. Default is false.
* @see setInsecureFallback()
*/
bool insecureFallback() const;
/**
* Set whether this job should use plaintext storage on unsupported platforms.
* @see insecureFallback()
*/
void setInsecureFallback( bool insecureFallback );
Q_SIGNALS:
void finished( QKeychain::Job* );
/**
* @return The string used as key by this job.
* @see setKey()
*/
QString key() const;
protected:
Q_INVOKABLE virtual void doStart() = 0;
/**
* Set the @p key that this job will use to read or write data from/to the keychain.
* The key can be an empty string.
* @see key()
*/
void setKey( const QString& key );
void setError( Error error );
void setErrorString( const QString& errorString );
void emitFinished();
void emitFinishedWithError(Error, const QString& errorString);
Q_SIGNALS:
/**
* Emitted when this job is finished.
* You can connect to this signal to be notified about the job's completion.
* @see start()
*/
void finished( QKeychain::Job* );
protected:
explicit Job( JobPrivate *q, QObject* parent=nullptr );
Q_INVOKABLE void doStart();
private:
void setError( Error error );
void setErrorString( const QString& errorString );
void scheduledStart();
protected:
JobPrivate* const d;
friend class JobExecutor;
friend class JobPrivate;
friend class ReadPasswordJobPrivate;
friend class WritePasswordJobPrivate;
friend class DeletePasswordJobPrivate;
};
class ReadPasswordJobPrivate;
/**
* @brief Job for reading secrets from the keychain.
* You can use a ReadPasswordJob to read passwords or binary data from the keychain.
* This job requires a "service" string, which is basically a namespace of keys within the keychain.
* This means that you can read all the pairs <key, secret> stored in the same service string.
*/
class QKEYCHAIN_EXPORT ReadPasswordJob : public Job {
Q_OBJECT
public:
explicit ReadPasswordJob( const QString& service, QObject* parent=0 );
~ReadPasswordJob();
QString key() const;
void setKey( const QString& key );
/**
* Create a new ReadPasswordJob.
* @param service The service string used by this job (can be empty).
* @param parent The parent of this job.
*/
explicit ReadPasswordJob( const QString& service, QObject* parent=nullptr );
~ReadPasswordJob() override;
/**
* @return The binary data stored as value of this job's key().
* @see Job::key()
*/
QByteArray binaryData() const;
QString textData() const;
protected:
void doStart();
/**
* @return The string stored as value of this job's key().
* @see Job::key()
* @warning Returns meaningless data if the data was stored as binary data.
* @see WritePasswordJob::setTextData()
*/
QString textData() const;
private:
friend class QKeychain::ReadPasswordJobPrivate;
friend class QKeychain::JobExecutor;
ReadPasswordJobPrivate* const d;
};
class WritePasswordJobPrivate;
/**
* @brief Job for writing secrets to the keychain.
* You can use a WritePasswordJob to store passwords or binary data in the keychain.
* This job requires a "service" string, which is basically a namespace of keys within the keychain.
* This means that you can store different pairs <key, secret> under the same service string.
*/
class QKEYCHAIN_EXPORT WritePasswordJob : public Job {
Q_OBJECT
public:
explicit WritePasswordJob( const QString& service, QObject* parent=0 );
~WritePasswordJob();
QString key() const;
void setKey( const QString& key );
/**
* Create a new WritePasswordJob.
* @param service The service string used by this job (can be empty).
* @param parent The parent of this job.
*/
explicit WritePasswordJob( const QString& service, QObject* parent=nullptr );
~WritePasswordJob() override;
/**
* Set the @p data that the job will store in the keychain as binary data.
* @warning setBinaryData() and setTextData() are mutually exclusive.
*/
void setBinaryData( const QByteArray& data );
/**
* Set the @p data that the job will store in the keychain as string.
* Typically @p data is a password.
* @warning setBinaryData() and setTextData() are mutually exclusive.
*/
void setTextData( const QString& data );
protected:
void doStart();
private:
friend class QKeychain::JobExecutor;
friend class QKeychain::WritePasswordJobPrivate;
friend class DeletePasswordJob;
WritePasswordJobPrivate* const d;
};
class DeletePasswordJobPrivate;
/**
* @brief Job for deleting secrets from the keychain.
* You can use a DeletePasswordJob to delete passwords or binary data from the keychain.
* This job requires a "service" string, which is basically a namespace of keys within the keychain.
* This means that you can delete all the pairs <key, secret> stored in the same service string.
*/
class QKEYCHAIN_EXPORT DeletePasswordJob : public Job {
Q_OBJECT
public:
explicit DeletePasswordJob( const QString& service, QObject* parent=0 );
~DeletePasswordJob();
QString key() const;
void setKey( const QString& key );
protected:
void doStart();
/**
* Create a new DeletePasswordJob.
* @param service The service string used by this job (can be empty).
* @param parent The parent of this job.
*/
explicit DeletePasswordJob( const QString& service, QObject* parent=nullptr );
~DeletePasswordJob() override;
private:
friend class QKeychain::DeletePasswordJobPrivate;
DeletePasswordJobPrivate* const d;
};
} // namespace QtKeychain