plugins: randomize iid

hsitter · hsitter · commit 5a92a111104c · 2025-02-17T02:11:22.000Z
this should help prevent accidentally loading an incompatible plugin
when building on top of a distro package or cmake configurations changed
over time such that the install dir might contain backends that are no
longer built

I did not find a built in way to achive this :(
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -27,6 +27,7 @@ include(KDEClangFormat)
 include(KDEGitCommitHooks)
 include(ECMFindQmlModule)
 include(ECMDeprecationSettings)
+include(ECMSourceVersionControl)
 
 find_package(Qt6 ${QT_MIN_VERSION} REQUIRED CONFIG COMPONENTS Widgets Test Network Concurrent DBus Quick QuickControls2)
 find_package(Qt6 ${QT_MIN_VERSION} CONFIG OPTIONAL_COMPONENTS WebView)
@@ -70,7 +71,23 @@ ecm_set_disabled_deprecation_versions(QT 6.8.1
 
 add_definitions(-DQT_NO_SIGNALS_SLOTS_KEYWORDS -DQT_NO_URL_CAST_FROM_STRING)
 
+# When building from git use a random iid to prevent loading incompatible plugins
+# from the distro or older git builds.
+set(DISCOVER_PLUGIN_IID ${PROJECT_VERSION})
+set(DISCOVER_NOTIFIER_IID ${PROJECT_VERSION})
+if(ECM_SOURCE_UNDER_VERSION_CONTROL)
+    string(RANDOM LENGTH 16 DISCOVER_PLUGIN_IID)
+    string(RANDOM LENGTH 16 DISCOVER_NOTIFIER_IID)
+endif()
+string(PREPEND DISCOVER_PLUGIN_IID "org.kde.discover.")
+string(APPEND DISCOVER_PLUGIN_IID ".AbstractResourcesBackendFactory")
+
+string(PREPEND DISCOVER_NOTIFIER_IID "org.kde.discover.")
+string(APPEND DISCOVER_NOTIFIER_IID ".BackendNotifierModule")
+
+configure_file(DiscoverConfig.h.in DiscoverConfig.h)
 configure_file(DiscoverVersion.h.in DiscoverVersion.h)
+include_directories(${CMAKE_CURRENT_BINARY_DIR})
 
 if(BUILD_TESTING AND CMAKE_SYSTEM_NAME MATCHES "Linux")
     add_subdirectory(appiumtests)
diff --git a/DiscoverConfig.h.in b/DiscoverConfig.h.in
@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: LGPL-2.0-or-later
+// SPDX-FileCopyrightText: 2025 Harald Sitter <sitter@kde.org>
+
+#pragma once
+
+#cmakedefine DISCOVER_PLUGIN_IID "@DISCOVER_PLUGIN_IID@"
+#cmakedefine DISCOVER_NOTIFIER_IID "@DISCOVER_NOTIFIER_IID@"
diff --git a/libdiscover/DiscoverBackendsFactory.cpp b/libdiscover/DiscoverBackendsFactory.cpp
@@ -19,6 +19,8 @@
 #include <QPluginLoader>
 #include <QStandardPaths>
 
+using namespace Qt::StringLiterals;
+
 Q_GLOBAL_STATIC(QStringList, s_requestedBackends)
 static bool s_isFeedback = false;
 
@@ -49,6 +51,11 @@ QVector<AbstractResourcesBackend *> DiscoverBackendsFactory::backendForFile(cons
 {
     QPluginLoader *loader = new QPluginLoader(QLatin1String("discover/") + libname, QCoreApplication::instance());
 
+    if (const auto iid = loader->metaData().value("IID"_L1).toString(); iid != QLatin1StringView(DISCOVER_PLUGIN_IID)) {
+        qCWarning(LIBDISCOVER_LOG) << "Plugin" << libname << "doesn't have the right IID" << iid << "expected" << DISCOVER_PLUGIN_IID;
+        return {};
+    }
+
     // qCDebug(LIBDISCOVER_LOG) << "trying to load plugin:" << loader->fileName();
     AbstractResourcesBackendFactory *f = qobject_cast<AbstractResourcesBackendFactory *>(loader->instance());
     if (!f) {
diff --git a/libdiscover/backends/DummyBackend/DummyNotifier.h b/libdiscover/backends/DummyBackend/DummyNotifier.h
@@ -10,7 +10,7 @@
 class DummyNotifier : public BackendNotifierModule
 {
     Q_OBJECT
-    Q_PLUGIN_METADATA(IID "org.kde.discover.BackendNotifierModule")
+    Q_PLUGIN_METADATA(IID DISCOVER_NOTIFIER_IID)
     Q_INTERFACES(BackendNotifierModule)
 public:
     explicit DummyNotifier(QObject *parent = nullptr);
diff --git a/libdiscover/backends/FlatpakBackend/FlatpakNotifier.h b/libdiscover/backends/FlatpakBackend/FlatpakNotifier.h
@@ -14,7 +14,7 @@
 class FlatpakNotifier : public BackendNotifierModule
 {
     Q_OBJECT
-    Q_PLUGIN_METADATA(IID "org.kde.discover.BackendNotifierModule")
+    Q_PLUGIN_METADATA(IID DISCOVER_NOTIFIER_IID)
     Q_INTERFACES(BackendNotifierModule)
 public:
     explicit FlatpakNotifier(QObject *parent = nullptr);
diff --git a/libdiscover/backends/KNSBackend/KNSBackend.cpp b/libdiscover/backends/KNSBackend/KNSBackend.cpp
@@ -41,7 +41,7 @@ static const int ENGINE_PAGE_SIZE = 100;
 class KNSBackendFactory : public AbstractResourcesBackendFactory
 {
     Q_OBJECT
-    Q_PLUGIN_METADATA(IID "org.kde.muon.AbstractResourcesBackendFactory")
+    Q_PLUGIN_METADATA(IID DISCOVER_PLUGIN_IID)
     Q_INTERFACES(AbstractResourcesBackendFactory)
 public:
     KNSBackendFactory()
diff --git a/libdiscover/backends/PackageKitBackend/PackageKitNotifier.h b/libdiscover/backends/PackageKitBackend/PackageKitNotifier.h
@@ -18,7 +18,7 @@ class QProcess;
 class PackageKitNotifier : public BackendNotifierModule
 {
     Q_OBJECT
-    Q_PLUGIN_METADATA(IID "org.kde.discover.BackendNotifierModule")
+    Q_PLUGIN_METADATA(IID DISCOVER_NOTIFIER_IID)
     Q_INTERFACES(BackendNotifierModule)
 public:
     explicit PackageKitNotifier(QObject *parent = nullptr);
diff --git a/libdiscover/backends/RpmOstreeBackend/RpmOstreeNotifier.h b/libdiscover/backends/RpmOstreeBackend/RpmOstreeNotifier.h
@@ -22,7 +22,7 @@
 class RpmOstreeNotifier : public BackendNotifierModule
 {
     Q_OBJECT
-    Q_PLUGIN_METADATA(IID "org.kde.discover.BackendNotifierModule")
+    Q_PLUGIN_METADATA(IID DISCOVER_NOTIFIER_IID)
     Q_INTERFACES(BackendNotifierModule)
 public:
     explicit RpmOstreeNotifier(QObject *parent = nullptr);
diff --git a/libdiscover/notifiers/BackendNotifierModule.h b/libdiscover/notifiers/BackendNotifierModule.h
@@ -6,6 +6,7 @@
 
 #pragma once
 
+#include "DiscoverConfig.h"
 #include "discovernotifiers_export.h"
 #include <QObject>
 
@@ -79,4 +80,4 @@ class DISCOVERNOTIFIERS_EXPORT BackendNotifierModule : public QObject
     void foundUpgradeAction(UpgradeAction *action);
 };
 
-Q_DECLARE_INTERFACE(BackendNotifierModule, "org.kde.discover.BackendNotifierModule")
+Q_DECLARE_INTERFACE(BackendNotifierModule, DISCOVER_NOTIFIER_IID)
diff --git a/libdiscover/resources/AbstractResourcesBackend.h b/libdiscover/resources/AbstractResourcesBackend.h
@@ -6,6 +6,8 @@
 
 #pragma once
 
+#include "DiscoverConfig.h"
+
 #include <QObject>
 #include <QPair>
 #include <QVariantList>
@@ -340,7 +342,7 @@ class DISCOVERCOMMON_EXPORT AbstractResourcesBackendFactory : public QObject
     class ClassName##Factory : public AbstractResourcesBackendFactory                                                                                          \
     {                                                                                                                                                          \
         Q_OBJECT                                                                                                                                               \
-        Q_PLUGIN_METADATA(IID "org.kde.muon.AbstractResourcesBackendFactory")                                                                                  \
+        Q_PLUGIN_METADATA(IID DISCOVER_PLUGIN_IID)                                                                                                             \
         Q_INTERFACES(AbstractResourcesBackendFactory)                                                                                                          \
     public:                                                                                                                                                    \
         QVector<AbstractResourcesBackend *> newInstance(QObject *parent, const QString &name) const override                                                   \
@@ -351,4 +353,4 @@ class DISCOVERCOMMON_EXPORT AbstractResourcesBackendFactory : public QObject
         }                                                                                                                                                      \
     };
 
-Q_DECLARE_INTERFACE(AbstractResourcesBackendFactory, "org.kde.muon.AbstractResourcesBackendFactory")
+Q_DECLARE_INTERFACE(AbstractResourcesBackendFactory, DISCOVER_PLUGIN_IID)
diff --git a/notifier/BackendNotifierFactory.cpp b/notifier/BackendNotifierFactory.cpp
@@ -11,6 +11,8 @@
 #include <QDir>
 #include <QPluginLoader>
 
+using namespace Qt::StringLiterals;
+
 BackendNotifierFactory::BackendNotifierFactory() = default;
 
 QList<BackendNotifierModule *> BackendNotifierFactory::allBackends() const
@@ -25,6 +27,13 @@ QList<BackendNotifierModule *> BackendNotifierFactory::allBackends() const
             QString fullPath = dir.absoluteFilePath(file);
             QPluginLoader loader(fullPath);
             loader.load();
+
+            if (const auto iid = loader.metaData().value("IID"_L1).toString(); iid != QLatin1StringView(DISCOVER_NOTIFIER_IID)) {
+                qWarning() << "Plugin" << fullPath << "doesn't have the right IID" << iid << "expected" << DISCOVER_NOTIFIER_IID;
+                ret.removeLast();
+                continue;
+            }
+
             ret += qobject_cast<BackendNotifierModule *>(loader.instance());
             if (ret.last() == nullptr) {
                 qWarning() << "couldn't load" << fullPath << "because" << loader.errorString();

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`class DummyNotifier : public BackendNotifierModule`
`11`	`11`	`{`
`12`	`12`	`Q_OBJECT`
`13`		`- Q_PLUGIN_METADATA(IID "org.kde.discover.BackendNotifierModule")`
	`13`	`+ Q_PLUGIN_METADATA(IID DISCOVER_NOTIFIER_IID)`
`14`	`14`	`Q_INTERFACES(BackendNotifierModule)`
`15`	`15`	`public:`
`16`	`16`	`explicit DummyNotifier(QObject *parent = nullptr);`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`class FlatpakNotifier : public BackendNotifierModule`
`15`	`15`	`{`
`16`	`16`	`Q_OBJECT`
`17`		`- Q_PLUGIN_METADATA(IID "org.kde.discover.BackendNotifierModule")`
	`17`	`+ Q_PLUGIN_METADATA(IID DISCOVER_NOTIFIER_IID)`
`18`	`18`	`Q_INTERFACES(BackendNotifierModule)`
`19`	`19`	`public:`
`20`	`20`	`explicit FlatpakNotifier(QObject *parent = nullptr);`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ static const int ENGINE_PAGE_SIZE = 100;`
`41`	`41`	`class KNSBackendFactory : public AbstractResourcesBackendFactory`
`42`	`42`	`{`
`43`	`43`	`Q_OBJECT`
`44`		`- Q_PLUGIN_METADATA(IID "org.kde.muon.AbstractResourcesBackendFactory")`
	`44`	`+ Q_PLUGIN_METADATA(IID DISCOVER_PLUGIN_IID)`
`45`	`45`	`Q_INTERFACES(AbstractResourcesBackendFactory)`
`46`	`46`	`public:`
`47`	`47`	`KNSBackendFactory()`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class QProcess;`
`18`	`18`	`class PackageKitNotifier : public BackendNotifierModule`
`19`	`19`	`{`
`20`	`20`	`Q_OBJECT`
`21`		`- Q_PLUGIN_METADATA(IID "org.kde.discover.BackendNotifierModule")`
	`21`	`+ Q_PLUGIN_METADATA(IID DISCOVER_NOTIFIER_IID)`
`22`	`22`	`Q_INTERFACES(BackendNotifierModule)`
`23`	`23`	`public:`
`24`	`24`	`explicit PackageKitNotifier(QObject *parent = nullptr);`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`class RpmOstreeNotifier : public BackendNotifierModule`
`23`	`23`	`{`
`24`	`24`	`Q_OBJECT`
`25`		`- Q_PLUGIN_METADATA(IID "org.kde.discover.BackendNotifierModule")`
	`25`	`+ Q_PLUGIN_METADATA(IID DISCOVER_NOTIFIER_IID)`
`26`	`26`	`Q_INTERFACES(BackendNotifierModule)`
`27`	`27`	`public:`
`28`	`28`	`explicit RpmOstreeNotifier(QObject *parent = nullptr);`