diff options
author | Ingo Klöcker <[email protected]> | 2023-12-21 08:38:52 +0000 |
---|---|---|
committer | Ingo Klöcker <[email protected]> | 2023-12-21 10:49:23 +0000 |
commit | a44d84772d6197dfb977b411f6eb7cb29b08471b (patch) | |
tree | d3b679026236ab83faabc36b94a466b6787f593d /lang/qt/src/encryptjob.h | |
parent | qt: Remove dead code (diff) | |
download | gpgme-a44d84772d6197dfb977b411f6eb7cb29b08471b.tar.gz gpgme-a44d84772d6197dfb977b411f6eb7cb29b08471b.zip |
qt: Support writing/reading signed/encrypted files directly to/from file
* lang/qt/src/Makefile.am: Add new files.
* lang/qt/src/job.cpp (EncryptJob, SignJob, SignEncryptJob): Move
definition of constructor and destructor and inclusion of the moc file
to the corresponding .cpp files.
* lang/qt/src/encryptjob.cpp (EncryptJob): Define constructor. Define
destructor as default. Include moc file.
* lang/qt/src/encryptjob.cpp, lang/qt/src/encryptjob.h (EncryptJob):
Add member functions setRecipients, recipients, setInputFile, inputFile,
setOutputFile, outputFile, setEncryptionFlags, encryptionFlags.
* lang/qt/src/encryptjob_p.h (EncryptJobPrivate): Add members
m_recipients, m_inputFilePath, m_outputFilePath, m_encryptionFlags.
* lang/qt/src/qgpgmeencryptjob.cpp (encrypt_to_filename): New.
(QGpgMEEncryptJobPrivate::startIt): Start the job with the values
from the member variables.
* lang/qt/src/qgpgmesignencryptjob.cpp (sign_encrypt_to_filename): New.
(QGpgMESignEncryptJobPrivate::startIt): Start the job with the values
from the member variables.
* lang/qt/src/qgpgmesignjob.cpp (class QGpgMESignJobPrivate): New.
(QGpgMESignJob::QGpgMESignJob): Instantiate private job class.
(sign_to_filename): New.
* lang/qt/src/signencryptjob.cpp (SignEncryptJob): Define constructor.
Define destructor as default. Include moc file.
* lang/qt/src/signencryptjob.cpp, lang/qt/src/signencryptjob.h
(SignEncryptJob): Add member functions setSigners, signers,
setRecipients, recipients, setInputFile, inputFile, setOutputFile,
outputFile, setEncryptionFlags, encryptionFlags.
* lang/qt/src/signencryptjob_p.h (SignEncryptJobPrivate): Add members
m_signers, m_recipients, m_inputFilePath, m_outputFilePath,
m_encryptionFlags.
* lang/qt/src/signjob.cpp: New.
* lang/qt/src/signjob.h (SignJob): Add member functions setSigners,
signers, setInputFile, inputFile, setOutputFile, outputFile,
setSigningFlags, signingFlags.
* lang/qt/src/signjob_p.h: New.
* lang/qt/tests/Makefile.am: Add new test programs.
* lang/qt/tests/run-encryptjob.cpp: New.
* lang/qt/tests/run-signjob.cpp: New.
--
This makes it possible to tell gpg to read the input and write the
output directly to a specified file bypassing GpgME's Data IO when
signing and/or encrypting a file.
GnuPG-bug-id: 6550
Diffstat (limited to 'lang/qt/src/encryptjob.h')
-rw-r--r-- | lang/qt/src/encryptjob.h | 60 |
1 files changed, 59 insertions, 1 deletions
diff --git a/lang/qt/src/encryptjob.h b/lang/qt/src/encryptjob.h index ac3664fa..48b36598 100644 --- a/lang/qt/src/encryptjob.h +++ b/lang/qt/src/encryptjob.h @@ -72,6 +72,15 @@ namespace QGpgME EncryptJob 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 and, optionally, recipients or flags. + 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 cipherText 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 EncryptJob will schedule it's own destruction by calling QObject::deleteLater(). */ @@ -81,15 +90,64 @@ class QGPGME_EXPORT EncryptJob : public Job protected: explicit EncryptJob(QObject *parent); public: - ~EncryptJob(); + ~EncryptJob() override; + /** + * Sets the file name to embed in the encryption result. + * + * This is only used if one of the start() functions is used. + */ void setFileName(const QString &fileName); QString fileName() const; + /** + * Sets the encoding of the plaintext. + * + * This is only used if one of the start() functions is used. + */ void setInputEncoding(GpgME::Data::Encoding); GpgME::Data::Encoding inputEncoding() const; /** + * Sets the keys to use for encryption. + * + * Used if the job is started with startIt(). + */ + void setRecipients(const std::vector<GpgME::Key> &recipients); + std::vector<GpgME::Key> recipients() const; + + /** + * Sets the path of the file to encrypt. + * + * Used if the job is started with startIt(). + */ + void setInputFile(const QString &path); + QString inputFile() const; + + /** + * Sets the path of the file to write the encryption 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. + */ + void setOutputFile(const QString &path); + QString outputFile() const; + + /** + * Sets the flags to use for encryption. + * + * Defaults to \c EncryptFile. + * + * Used if the job is started with startIt(). The \c EncryptFile flag is + * always assumed set. + */ + void setEncryptionFlags(GpgME::Context::EncryptionFlags flags); + GpgME::Context::EncryptionFlags encryptionFlags() const; + + /** Starts the encryption operation. \a recipients is the a list of keys to encrypt \a plainText to. Empty (null) keys are ignored. If \a recipients is empty, performs symmetric |