QGpgME 21.6.2.0000005
Qt API for GpgME
Loading...
Searching...
No Matches
Signals | Public Member Functions | Protected Member Functions | List of all members
QGpgME::DecryptVerifyJob Class Referenceabstract

An abstract base class for asynchronous combined decrypters and verifiers. More...

#include <decryptverifyjob.h>

Inheritance diagram for QGpgME::DecryptVerifyJob:
Inheritance graph
[legend]
Collaboration diagram for QGpgME::DecryptVerifyJob:
Collaboration graph
[legend]

Signals

void result (const GpgME::DecryptionResult &decryptionresult, const GpgME::VerificationResult &verificationresult, const QByteArray &plainText, const QString &auditLogAsHtml=QString(), const GpgME::Error &auditLogError=GpgME::Error())
 
- Signals inherited from QGpgME::Job
void jobProgress (int current, int total)
 
void rawProgress (const QString &what, int type, int current, int total)
 
QGPGME_DEPRECATED void progress (const QString &what, int current, int total)
 
void done ()
 

Public Member Functions

void setProcessAllSignatures (bool processAll)
 
bool processAllSignatures () const
 
void setInputFile (const QString &path)
 
QString inputFile () const
 
void setOutputFile (const QString &path)
 
QString outputFile () const
 
virtual GpgME::Error start (const QByteArray &cipherText)=0
 
virtual void start (const std::shared_ptr< QIODevice > &cipherText, const std::shared_ptr< QIODevice > &plainText=std::shared_ptr< QIODevice >())=0
 
virtual std::pair< GpgME::DecryptionResult, GpgME::VerificationResult > exec (const QByteArray &cipherText, QByteArray &plainText)=0
 
- Public Member Functions inherited from QGpgME::Job
virtual QString auditLogAsHtml () const
 
virtual GpgME::Error auditLogError () const
 
bool isAuditLogSupported () const
 
GpgME::Error startIt ()
 
void startNow ()
 

Protected Member Functions

 DecryptVerifyJob (QObject *parent)
 
- Protected Member Functions inherited from QGpgME::Job
 Job (QObject *parent)
 

Additional Inherited Members

- Public Slots inherited from QGpgME::Job
virtual void slotCancel ()=0
 
- Static Public Member Functions inherited from QGpgME::Job
static GpgME::Context * context (Job *job)
 

Detailed Description

An abstract base class for asynchronous combined decrypters and verifiers.

To use a DecryptVerifyJob, first obtain an instance from the CryptoBackend implementation, connect the progress() and result() signals to suitable slots and then start the operation with a call to start(). This call might fail, in which case the DecryptVerifyJob instance will have scheduled it's own destruction with a call to QObject::deleteLater().

Alternatively, the job can be started with startIt() after setting an input file and an output file. If the job is started this way then the backend reads the input and writes the output directly from/to the specified input file and output file. In this case the plainText value of the result signal will always be empty. This direct IO mode is currently only supported for OpenPGP. Note that startIt() does not schedule the job's destruction if starting the job failed.

After result() is emitted, the DecryptVerifyJob will schedule it's own destruction by calling QObject::deleteLater().

Member Function Documentation

◆ exec()

virtual std::pair< GpgME::DecryptionResult, GpgME::VerificationResult > QGpgME::DecryptVerifyJob::exec ( const QByteArray cipherText,
QByteArray plainText 
)
pure virtual

Synchronous equivalent of start()

Implemented in QGpgME::QGpgMEDecryptVerifyJob.

◆ setInputFile()

void DecryptVerifyJob::setInputFile ( const QString path)

Sets the path of the file to decrypt (and verify).

Used if the job is started with startIt().

◆ setOutputFile()

void DecryptVerifyJob::setOutputFile ( const QString path)

Sets the path of the file to write the result to.

Used if the job is started with startIt().

Note
If a file with this path exists, then the job will fail, i.e. you need to delete an existing file that shall be overwritten before you start the job.

◆ setProcessAllSignatures()

void DecryptVerifyJob::setProcessAllSignatures ( bool  processAll)

Enables processing of all signatures if processAll is true.

By default, gpg (in batch mode used by GpgME) stops the verification of data signatures when a bad signature is encountered. This can be changed by setting this flag. It's equivalent to setting the context flag "proc-all-sigs".

This is only supported for OpenPGP and requires GnuPG 2.2.45, 2.4.6, or 2.5.1.

◆ start() [1/2]

virtual GpgME::Error QGpgME::DecryptVerifyJob::start ( const QByteArray cipherText)
pure virtual

Starts the combined decryption and verification operation. cipherText is the data to decrypt and later verify.

Implemented in QGpgME::QGpgMEDecryptVerifyJob.

◆ start() [2/2]

virtual void QGpgME::DecryptVerifyJob::start ( const std::shared_ptr< QIODevice > &  cipherText,
const std::shared_ptr< QIODevice > &  plainText = std::shared_ptr< QIODevice >() 
)
pure virtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

If plainText is non-null, the plaintext is written there. Otherwise, it will be delivered in the third argument of result().

Implemented in QGpgME::QGpgMEDecryptVerifyJob.


The documentation for this class was generated from the following files: