/* t-encrypt.cpp
This file is part of qgpgme, the Qt API binding for gpgme
Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik
Software engineering by Intevation GmbH
QGpgME is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
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 <QDebug>
#include <QTest>
#include <QTemporaryDir>
#include <QSignalSpy>
#include <QBuffer>
#include "keylistjob.h"
#include "encryptjob.h"
#include "signencryptjob.h"
#include "signingresult.h"
#include "encryptjob.h"
#include "encryptionresult.h"
#include "decryptionresult.h"
#include "decryptjob.h"
#include "qgpgmebackend.h"
#include "keylistresult.h"
#include "engineinfo.h"
#include "verifyopaquejob.h"
#include "t-support.h"
#define PROGRESS_TEST_SIZE 1 * 1024 * 1024
using namespace QGpgME;
using namespace GpgME;
static bool decryptSupported()
{
/* With GnuPG 2.0.x (at least 2.0.26 by default on jessie)
* the passphrase_cb does not work. So the test popped up
* a pinentry. So tests requiring decryption don't work. */
static auto version = GpgME::engineInfo(GpgME::GpgEngine).engineVersion();
if (version < "2.0.0") {
/* With 1.4 it just works */
return true;
}
if (version < "2.1.0") {
/* With 2.1 it works with loopback mode */
return false;
}
return true;
}
class EncryptionTest : public QGpgMETest
{
Q_OBJECT
Q_SIGNALS:
void asyncDone();
private Q_SLOTS:
void testSimpleEncryptDecrypt()
{
auto listjob = openpgp()->keyListJob(false, false, false);
std::vector<Key> keys;
auto keylistresult = listjob->exec(QStringList() << QStringLiteral("alfa@example.net"),
false, keys);
QVERIFY(!keylistresult.error());
QVERIFY(keys.size() == 1);
delete listjob;
auto job = openpgp()->encryptJob(/*ASCII Armor */true, /* Textmode */ true);
QVERIFY(job);
QByteArray cipherText;
auto result = job->exec(keys, QStringLiteral("Hello World").toUtf8(), Context::AlwaysTrust, cipherText);
delete job;
QVERIFY(!result.error());
const auto cipherString = QString::fromUtf8(cipherText);
QVERIFY(cipherString.startsWith("-----BEGIN PGP MESSAGE-----"));
/* Now decrypt */
if (!decryptSupported()) {
return;
}
auto decJob = openpgp()->decryptJob();
auto ctx = Job::context(decJob);
TestPassphraseProvider provider;
ctx->setPassphraseProvider(&provider);
ctx->setPinentryMode(Context::PinentryLoopback);
QByteArray plainText;
auto decResult = decJob->exec(cipherText, plainText);
QVERIFY(!decResult.error());
QVERIFY(QString::fromUtf8(plainText) == QStringLiteral("Hello World"));
delete decJob;
}
void testProgress()
{
if (GpgME::engineInfo(GpgME::GpgEngine).engineVersion() < "2.1.15") {
// We can only test the progress with 2.1.15 as this started to
// have total progress for memory callbacks
return;
}
auto listjob = openpgp()->keyListJob(false, false, false);
std::vector<Key> keys;
auto keylistresult = listjob->exec(QStringList() << QStringLiteral("alfa@example.net"),
false, keys);
QVERIFY(!keylistresult.error());
QVERIFY(keys.size() == 1);
delete listjob;
auto job = openpgp()->encryptJob(/*ASCII Armor */false, /* Textmode */ false);
QVERIFY(job);
QByteArray plainBa;
plainBa.fill('X', PROGRESS_TEST_SIZE);
QByteArray cipherText;
bool initSeen = false;
bool finishSeen = false;
connect(job, &Job::progress, this, [this, &initSeen, &finishSeen] (const QString&, int current, int total) {
// We only check for progress 0 and max progress as the other progress
// lines depend on the system speed and are as such unreliable to test.
QVERIFY(total == PROGRESS_TEST_SIZE);
if (current == 0) {
initSeen = true;
}
if (current == total) {
finishSeen = true;
}
QVERIFY(current >= 0 && current <= total);
});
connect(job, &EncryptJob::result, this, [this, &initSeen, &finishSeen] (const GpgME::EncryptionResult &,
const QByteArray &,
const QString,
const GpgME::Error) {
QVERIFY(initSeen);
QVERIFY(finishSeen);
Q_EMIT asyncDone();
});
auto inptr = std::shared_ptr<QIODevice>(new QBuffer(&plainBa));
inptr->open(QIODevice::ReadOnly);
auto outptr = std::shared_ptr<QIODevice>(new QBuffer(&cipherText));
outptr->open(QIODevice::WriteOnly);
job->start(keys, inptr, outptr, Context::AlwaysTrust);
QSignalSpy spy (this, SIGNAL(asyncDone()));
QVERIFY(spy.wait(QSIGNALSPY_TIMEOUT));
}
void testSymmetricEncryptDecrypt()
{
if (!decryptSupported()) {
return;
}
auto job = openpgp()->encryptJob();
auto ctx = Job::context(job);
TestPassphraseProvider provider;
ctx->setPassphraseProvider(&provider);
ctx->setPinentryMode(Context::PinentryLoopback);
ctx->setArmor(true);
ctx->setTextMode(true);
QByteArray cipherText;
auto result = job->exec(std::vector<Key>(), QStringLiteral("Hello symmetric World").toUtf8(), Context::AlwaysTrust, cipherText);
delete job;
QVERIFY(!result.error());
const auto cipherString = QString::fromUtf8(cipherText);
QVERIFY(cipherString.startsWith("-----BEGIN PGP MESSAGE-----"));
killAgent(mDir.path());
auto decJob = openpgp()->decryptJob();
auto ctx2 = Job::context(decJob);
ctx2->setPassphraseProvider(&provider);
ctx2->setPinentryMode(Context::PinentryLoopback);
QByteArray plainText;
auto decResult = decJob->exec(cipherText, plainText);
QVERIFY(!result.error());
QVERIFY(QString::fromUtf8(plainText) == QStringLiteral("Hello symmetric World"));
delete decJob;
}
void testEncryptDecryptNowrap()
{
/* Now decrypt */
if (!decryptSupported()) {
return;
}
auto listjob = openpgp()->keyListJob(false, false, false);
std::vector<Key> keys;
auto keylistresult = listjob->exec(QStringList() << QStringLiteral("alfa@example.net"),
false, keys);
QVERIFY(!keylistresult.error());
QVERIFY(keys.size() == 1);
delete listjob;
auto job = openpgp()->signEncryptJob(/*ASCII Armor */true, /* Textmode */ true);
auto encSignCtx = Job::context(job);
TestPassphraseProvider provider1;
encSignCtx->setPassphraseProvider(&provider1);
encSignCtx->setPinentryMode(Context::PinentryLoopback);
QVERIFY(job);
QByteArray cipherText;
auto result = job->exec(keys, keys, QStringLiteral("Hello World").toUtf8(), Context::AlwaysTrust, cipherText);
delete job;
QVERIFY(!result.first.error());
QVERIFY(!result.second.error());
const auto cipherString = QString::fromUtf8(cipherText);
QVERIFY(cipherString.startsWith("-----BEGIN PGP MESSAGE-----"));
/* Now decrypt */
if (!decryptSupported()) {
return;
}
auto decJob = openpgp()->decryptJob();
auto ctx = Job::context(decJob);
TestPassphraseProvider provider;
ctx->setPassphraseProvider(&provider);
ctx->setPinentryMode(Context::PinentryLoopback);
ctx->setDecryptionFlags(Context::DecryptUnwrap);
QByteArray plainText;
auto decResult = decJob->exec(cipherText, plainText);
QVERIFY(!decResult.error());
delete decJob;
// Now verify the unwrapeped data.
auto verifyJob = openpgp()->verifyOpaqueJob(true);
QByteArray verified;
auto verResult = verifyJob->exec(plainText, verified);
QVERIFY(!verResult.error());
delete verifyJob;
QVERIFY(verResult.numSignatures() == 1);
auto sig = verResult.signatures()[0];
QVERIFY(verified == QStringLiteral("Hello World"));
}
private:
/* Loopback and passphrase provider don't work for mixed encryption.
* So this test is disabled until gnupg(?) is fixed for this. */
void testMixedEncryptDecrypt()
{
if (!decryptSupported()) {
return;
}
auto listjob = openpgp()->keyListJob(false, false, false);
std::vector<Key> keys;
auto keylistresult = listjob->exec(QStringList() << QStringLiteral("alfa@example.net"),
false, keys);
QVERIFY(!keylistresult.error());
QVERIFY(keys.size() == 1);
delete listjob;
auto job = openpgp()->encryptJob();
auto ctx = Job::context(job);
ctx->setPassphraseProvider(new TestPassphraseProvider);
ctx->setPinentryMode(Context::PinentryLoopback);
ctx->setArmor(true);
ctx->setTextMode(true);
QByteArray cipherText;
printf("Before exec, flags: %x\n", Context::Symmetric | Context::AlwaysTrust);
auto result = job->exec(keys, QStringLiteral("Hello symmetric World").toUtf8(),
static_cast<Context::EncryptionFlags>(Context::Symmetric | Context::AlwaysTrust),
cipherText);
printf("After exec\n");
delete job;
QVERIFY(!result.error());
printf("Cipher:\n%s\n", cipherText.constData());
const auto cipherString = QString::fromUtf8(cipherText);
QVERIFY(cipherString.startsWith("-----BEGIN PGP MESSAGE-----"));
killAgent(mDir.path());
/* Now create a new homedir which with we test symmetric decrypt. */
QTemporaryDir tmp;
qputenv("GNUPGHOME", tmp.path().toUtf8());
QFile agentConf(tmp.path() + QStringLiteral("/gpg-agent.conf"));
QVERIFY(agentConf.open(QIODevice::WriteOnly));
agentConf.write("allow-loopback-pinentry");
agentConf.close();
auto decJob = openpgp()->decryptJob();
auto ctx2 = Job::context(decJob);
ctx2->setPassphraseProvider(new TestPassphraseProvider);
ctx2->setPinentryMode(Context::PinentryLoopback);
ctx2->setTextMode(true);
QByteArray plainText;
auto decResult = decJob->exec(cipherText, plainText);
QVERIFY(!decResult.error());
qDebug() << "Plain: " << plainText;
QVERIFY(QString::fromUtf8(plainText) == QStringLiteral("Hello symmetric World"));
delete decJob;
killAgent(tmp.path());
qputenv("GNUPGHOME", mDir.path().toUtf8());
}
public Q_SLOT:
void initTestCase()
{
QGpgMETest::initTestCase();
const QString gpgHome = qgetenv("GNUPGHOME");
qputenv("GNUPGHOME", mDir.path().toUtf8());
QVERIFY(mDir.isValid());
QFile agentConf(mDir.path() + QStringLiteral("/gpg-agent.conf"));
QVERIFY(agentConf.open(QIODevice::WriteOnly));
agentConf.write("allow-loopback-pinentry");
agentConf.close();
QVERIFY(copyKeyrings(gpgHome, mDir.path()));
}
private:
QTemporaryDir mDir;
};
QTEST_MAIN(EncryptionTest)
#include "t-encrypt.moc"