qt: Support WKD lookup without implicit import

* lang/qt/src/Makefile.am (qgpgme_sources): Add qgpgmewkdlookupjob.cpp,
wkdlookupresult.cpp.
(qgpgme_headers): Add wkdlookupjob.h, wkdlookupresult.h.
(camelcase_headers): Add WKDLookupJob, WKDLookupResult.
(private_qgpgme_headers): Add qgpgmewkdlookupjob.h.
(qgpgme_moc_sources): Add qgpgmewkdlookupjob.moc, wkdlookupjob.moc.
* lang/qt/src/job.cpp: Define c'tor and d'tor of WKDLookupJob.
* lang/qt/src/protocol.h (Protocol::wkdLookupJob): New.
* lang/qt/src/protocol_p.h (Protocol::wkdLookupJob): New.
* lang/qt/src/qgpgmewkdlookupjob.cpp, lang/qt/src/qgpgmewkdlookupjob.h,
lang/qt/src/wkdlookupjob.h, lang/qt/src/wkdlookupresult.cpp,
lang/qt/src/wkdlookupresult.h: New.

* lang/qt/tests/Makefile.am (EXTRA_DIST): Add final.test.
(the_tests): New.
(TESTS): Remove all t-*. Add $(the_tests) and final.test.
(moc_files): Add t-wkdlookup.moc.
(t_wkdlookup_SOURCES): New.
(noinst_PROGRAMS): Add t-wkdlookup.
* lang/qt/tests/final.test: New.
* lang/qt/tests/t-support.h (QTest::toString): New template
specialization for std::string.
* lang/qt/tests/t-wkdlookup.cpp: New.
--

The new WKDLookupJob allows running a WKD lookup without implicit
import of the retrieved key. This makes it possible to do WKD lookups
similar to keyserver lookups (aka external keylistings).

The new final.test pseudo test stops a dirmngr that may have been
started by the tests. The toString() template specialization enables
printing of the actual and expected values in case of failed QCOMPARE.

GnuPG-bug-id: 5728

4 files changed, 174 insertions, 6 deletions

diff --git a/lang/qt/tests/Makefile.am b/lang/qt/tests/Makefile.am
index 8c44681b..b7ec546e 100644
--- a/lang/qt/tests/Makefile.am
+++ b/lang/qt/tests/Makefile.am
@@ -24,16 +24,19 @@ GPG = gpg
 GNUPGHOME=$(abs_builddir)
 TESTS_ENVIRONMENT = GNUPGHOME=$(GNUPGHOME)
 
-EXTRA_DIST = initial.test
+EXTRA_DIST = initial.test final.test
 
-TESTS = initial.test t-keylist t-keylocate t-ownertrust t-tofuinfo \
-        t-encrypt t-verify t-various t-config t-remarks t-trustsignatures \
-        t-changeexpiryjob
+the_tests = \
+	t-keylist t-keylocate t-ownertrust t-tofuinfo \
+	t-encrypt t-verify t-various t-config t-remarks t-trustsignatures \
+	t-changeexpiryjob t-wkdlookup
+
+TESTS = initial.test $(the_tests) final.test
 
 moc_files = t-keylist.moc t-keylocate.moc t-ownertrust.moc t-tofuinfo.moc \
             t-encrypt.moc t-support.hmoc t-wkspublish.moc t-verify.moc \
             t-various.moc t-config.moc t-remarks.moc t-trustsignatures.moc \
-            t-changeexpiryjob.moc
+            t-changeexpiryjob.moc t-wkdlookup.moc
 
 AM_LDFLAGS = -no-install
 
@@ -61,6 +64,7 @@ t_config_SOURCES = t-config.cpp $(support_src)
 t_remarks_SOURCES = t-remarks.cpp $(support_src)
 t_trustsignatures_SOURCES = t-trustsignatures.cpp $(support_src)
 t_changeexpiryjob_SOURCES = t-changeexpiryjob.cpp $(support_src)
+t_wkdlookup_SOURCES = t-wkdlookup.cpp $(support_src)
 run_keyformailboxjob_SOURCES = run-keyformailboxjob.cpp
 
 nodist_t_keylist_SOURCES = $(moc_files)
@@ -69,7 +73,7 @@ BUILT_SOURCES = $(moc_files) pubring-stamp
 
 noinst_PROGRAMS = t-keylist t-keylocate t-ownertrust t-tofuinfo t-encrypt \
     run-keyformailboxjob t-wkspublish t-verify t-various t-config t-remarks \
-    t-trustsignatures t-changeexpiryjob
+    t-trustsignatures t-changeexpiryjob t-wkdlookup
 
 CLEANFILES = secring.gpg pubring.gpg pubring.kbx trustdb.gpg dirmngr.conf \
 	gpg-agent.conf pubring.kbx~ S.gpg-agent gpg.conf pubring.gpg~ \
diff --git a/lang/qt/tests/final.test b/lang/qt/tests/final.test
new file mode 100755
index 00000000..f28aaa4c
--- /dev/null
+++ b/lang/qt/tests/final.test
@@ -0,0 +1,6 @@
+#!/bin/sh
+
+# stop the dirmngr that may have been started
+gpgconf --kill dirmngr
+
+exit 0
diff --git a/lang/qt/tests/t-support.h b/lang/qt/tests/t-support.h
index 77bef56d..22ba473c 100644
--- a/lang/qt/tests/t-support.h
+++ b/lang/qt/tests/t-support.h
@@ -34,9 +34,19 @@
 
 #include "interfaces/passphraseprovider.h"
 #include <QObject>
+#include <QTest>
 
 #include <gpg-error.h>
 
+namespace QTest
+{
+template <>
+inline char *toString(const std::string &s)
+{
+    return QTest::toString(s.c_str());
+}
+}
+
 namespace GpgME
 {
 class TestPassphraseProvider : public PassphraseProvider
diff --git a/lang/qt/tests/t-wkdlookup.cpp b/lang/qt/tests/t-wkdlookup.cpp
new file mode 100644
index 00000000..13c70269
--- /dev/null
+++ b/lang/qt/tests/t-wkdlookup.cpp
@@ -0,0 +1,148 @@
+/* t-wkdlookup.cpp
+
+    This file is part of qgpgme, the Qt API binding for gpgme
+    Copyright (c) 2021 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 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 "t-support.h"
+
+#include "data.h"
+#include "engineinfo.h"
+#include "protocol.h"
+#include "wkdlookupjob.h"
+#include "wkdlookupresult.h"
+
+#include <QDebug>
+#include <QSignalSpy>
+#include <QTest>
+
+#include <algorithm>
+
+using namespace QGpgME;
+using namespace GpgME;
+
+static const char *requiredVersion = "2.1.12";
+
+namespace
+{
+bool keyHasUserIDWithMatchingEmailAddress(const Key &key, const QString &expectedEmailAddress)
+{
+    const auto email = expectedEmailAddress.toLower();
+    const auto userIds = key.userIDs();
+    return std::any_of(
+        std::begin(userIds), std::end(userIds),
+        [email](const UserID &uid) {
+            return email == QString::fromUtf8(uid.email()).toLower();
+        });
+}
+}
+
+class WKDLookupTest : public QGpgMETest
+{
+    Q_OBJECT
+
+Q_SIGNALS:
+    void asyncDone();
+
+private Q_SLOTS:
+
+#ifndef DO_ONLINE_TESTS
+    void testWKDLookupAsync()
+    {
+        if (GpgME::engineInfo(GpgME::GpgEngine).engineVersion() < requiredVersion) {
+            QSKIP("dirmngr does not yet support WKD lookup");
+        }
+        const QString email = QLatin1String{"[email protected]"};
+
+        WKDLookupResult result;
+        auto *job = openpgp()->wkdLookupJob();
+        connect(job, &WKDLookupJob::result, job, [this, &result](const WKDLookupResult &result_, const QString &, const Error &)
+        {
+            result = result_;
+            Q_EMIT asyncDone();
+        });
+        job->start(email);
+        QSignalSpy spy (this, SIGNAL(asyncDone()));
+        QVERIFY(spy.wait(QSIGNALSPY_TIMEOUT));
+
+        QVERIFY(result.error().code() == GPG_ERR_NO_ERROR);
+        QCOMPARE(result.source(), "https://openpgpkey.gnupg.org");
+        const auto keys = result.keyData().toKeys(GpgME::OpenPGP);
+        QVERIFY(keys.size() == 1);
+        QVERIFY(keyHasUserIDWithMatchingEmailAddress(keys.front(), email));
+    }
+
+    void testWKDLookupSync()
+    {
+        if (GpgME::engineInfo(GpgME::GpgEngine).engineVersion() < requiredVersion) {
+            QSKIP("dirmngr does not yet support WKD lookup");
+        }
+        const QString email = QLatin1String{"[email protected]"};
+
+        auto *job = openpgp()->wkdLookupJob();
+        const auto result = job->exec(email);
+
+        QVERIFY(result.error().code() == GPG_ERR_NO_ERROR);
+        QCOMPARE(result.source(), "https://openpgpkey.gnupg.org");
+        const auto keys = result.keyData().toKeys(GpgME::OpenPGP);
+        QVERIFY(keys.size() == 1);
+        QVERIFY(keyHasUserIDWithMatchingEmailAddress(keys.front(), email));
+    }
+
+    void testLookupWithNoResultAsync()
+    {
+        if (GpgME::engineInfo(GpgME::GpgEngine).engineVersion() < requiredVersion) {
+            QSKIP("dirmngr does not yet support WKD lookup");
+        }
+        const QString email = QLatin1String{"[email protected]"};
+
+        WKDLookupResult result;
+        auto *job = openpgp()->wkdLookupJob();
+        connect(job, &WKDLookupJob::result, job, [this, &result](const WKDLookupResult &result_, const QString &, const Error &)
+        {
+            result = result_;
+            Q_EMIT asyncDone();
+        });
+        job->start(email);
+        QSignalSpy spy (this, SIGNAL(asyncDone()));
+        QVERIFY(spy.wait(QSIGNALSPY_TIMEOUT));
+
+        QVERIFY(result.error().code() == GPG_ERR_NO_ERROR);
+        QCOMPARE(result.source(), "");
+        QVERIFY(result.keyData().isNull());
+    }
+#endif
+};
+
+QTEST_MAIN(WKDLookupTest)
+
+#include "t-wkdlookup.moc"