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

1 files changed, 198 insertions, 0 deletions

diff --git a/lang/qt/tests/run-encryptjob.cpp b/lang/qt/tests/run-encryptjob.cpp
new file mode 100644
index 00000000..c3d6c9ee
--- /dev/null
+++ b/lang/qt/tests/run-encryptjob.cpp
@@ -0,0 +1,198 @@
+/*
+    run-encryptjob.cpp
+
+    This file is part of QGpgME's test suite.
+    Copyright (c) 2023 by g10 Code GmbH
+    Software engineering by Ingo Klöcker <[email protected]>
+
+    QGpgME is free software; you can redistribute it and/or
+    modify it under the terms of the GNU General Public License,
+    version 2, as published by the Free Software Foundation.
+
+    QGpgME 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
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of this program with any edition of
+    the Qt library by Trolltech AS, Norway (or with modified versions
+    of Qt that use the same license as Qt), and distribute linked
+    combinations including the two.  You must obey the GNU General
+    Public License in all respects for all of the code used other than
+    Qt.  If you modify this file, you may extend this exception to
+    your version of the file, but you are not obligated to do so.  If
+    you do not wish to do so, delete this exception statement from
+    your version.
+*/
+
+#ifdef HAVE_CONFIG_H
+ #include "config.h"
+#endif
+
+#include <protocol.h>
+#include <encryptjob.h>
+#include <signencryptjob.h>
+
+#include <QCommandLineParser>
+#include <QCoreApplication>
+#include <QDebug>
+#include <QFile>
+#include <QTimer>
+
+#include <context.h>
+#include <encryptionresult.h>
+#include <signingresult.h>
+
+#include <iostream>
+
+using namespace GpgME;
+
+std::ostream &operator<<(std::ostream &os, const QString &s)
+{
+    return os << s.toLocal8Bit().constData();
+}
+
+struct CommandLineOptions {
+    bool armor = false;
+    bool sign = false;
+    QString inputFile;
+    QString outputFile;
+    std::chrono::seconds cancelTimeout{0};
+};
+
+CommandLineOptions parseCommandLine(const QStringList &arguments)
+{
+    CommandLineOptions options;
+
+    QCommandLineParser parser;
+    parser.setApplicationDescription("Test program for EncryptJob and SignEncryptJob");
+    parser.addHelpOption();
+    parser.addOptions({
+        {{"s", "sign"}, "Sign file before encryption."},
+        {{"o", "output"}, "Write output to FILE.", "FILE"},
+        {{"a", "armor"}, "Create ASCII armored output."},
+        {"cancel-after", "Cancel the running job after SECONDS seconds.", "SECONDS"},
+    });
+    parser.addPositionalArgument("file", "File to encrypt", "FILE");
+
+    parser.process(arguments);
+
+    const auto args = parser.positionalArguments();
+    if (args.size() != 1) {
+        parser.showHelp(1);
+    }
+
+    options.armor = parser.isSet("armor");
+    options.sign = parser.isSet("sign");
+    options.inputFile = args.front();
+    options.outputFile = parser.value("output");
+    if (parser.isSet("cancel-after")) {
+        bool ok;
+        options.cancelTimeout = std::chrono::seconds{parser.value("cancel-after").toInt(&ok)};
+        if (!ok) {
+            options.cancelTimeout = std::chrono::seconds{-1};
+        }
+    }
+
+    return options;
+}
+
+int main(int argc, char **argv)
+{
+    GpgME::initializeLibrary();
+
+    QCoreApplication app{argc, argv};
+    app.setApplicationName("run-encryptjob");
+
+    const auto options = parseCommandLine(app.arguments());
+    if (options.cancelTimeout.count() < 0) {
+        std::cerr << "Ignoring invalid timeout for cancel." << std::endl;
+    }
+
+    std::shared_ptr<QFile> output;
+    if (options.outputFile.isEmpty() || options.outputFile == QLatin1String{"-"}) {
+        output.reset(new QFile);
+        output->open(stdout, QIODevice::WriteOnly);
+    } else {
+        if (QFile::exists(options.outputFile)) {
+            qCritical() << "File" << options.outputFile << "exists. Bailing out.";
+            return 1;
+        }
+    }
+
+    std::shared_ptr<QFile> input;
+
+    if (options.sign) {
+        auto job = QGpgME::openpgp()->signEncryptJob(options.armor);
+        if (!job) {
+            std::cerr << "Error: Could not create job" << std::endl;
+            return 1;
+        }
+        QObject::connect(job, &QGpgME::SignEncryptJob::result, &app, [](const GpgME::SigningResult &signingResult, const GpgME::EncryptionResult &encryptionResult, const QByteArray &, const QString &auditLog, const GpgME::Error &) {
+            std::cerr << "Diagnostics: " << auditLog << std::endl;
+            std::cerr << "Signing Result: " << signingResult << std::endl;
+            std::cerr << "Encryption Result: " << encryptionResult << std::endl;
+            qApp->quit();
+        });
+        if (options.cancelTimeout.count() > 0) {
+            QTimer::singleShot(options.cancelTimeout, job, [job]() {
+                std::cerr << "Canceling job" << std::endl;
+                job->slotCancel();
+            });
+        }
+
+        GpgME::Error err;
+        if (output) {
+            input.reset(new QFile{options.inputFile});
+            input->open(QIODevice::ReadOnly);
+            job->start({}, {}, input, output, GpgME::Context::None);
+        } else {
+            job->setInputFile(options.inputFile);
+            job->setOutputFile(options.outputFile);
+            err = job->startIt();
+        }
+        if (err) {
+            std::cerr << "Error: Starting the job failed: " << err.asString() << std::endl;
+            return 1;
+        }
+    } else {
+        auto job = QGpgME::openpgp()->encryptJob(options.armor);
+        if (!job) {
+            std::cerr << "Error: Could not create job" << std::endl;
+            return 1;
+        }
+        QObject::connect(job, &QGpgME::EncryptJob::result, &app, [](const GpgME::EncryptionResult &result, const QByteArray &, const QString &auditLog, const GpgME::Error &) {
+            std::cerr << "Diagnostics: " << auditLog << std::endl;
+            std::cerr << "Result: " << result << std::endl;
+            qApp->quit();
+        });
+        if (options.cancelTimeout.count() > 0) {
+            QTimer::singleShot(options.cancelTimeout, job, [job]() {
+                std::cerr << "Canceling job" << std::endl;
+                job->slotCancel();
+            });
+        }
+
+        GpgME::Error err;
+        if (output) {
+            input.reset(new QFile{options.inputFile});
+            input->open(QIODevice::ReadOnly);
+            job->start({}, input, output, GpgME::Context::None);
+        } else {
+            job->setInputFile(options.inputFile);
+            job->setOutputFile(options.outputFile);
+            err = job->startIt();
+        }
+        if (err) {
+            std::cerr << "Error: Starting the job failed: " << err.asString() << std::endl;
+            return 1;
+        }
+    }
+
+    return app.exec();
+}