Issue 1862 : Extend PluginManager to support loading of plugins from JARs

apiserver/src/main/java/org/dependencytrack/plugin/PluginInitializer.java

@@ -22,6 +22,8 @@
 
 import jakarta.servlet.ServletContextEvent;
 import jakarta.servlet.ServletContextListener;
+import org.eclipse.microprofile.config.Config;
+import org.eclipse.microprofile.config.ConfigProvider;
 
 /**
  * @since 5.6.0
@@ -32,9 +34,16 @@ public class PluginInitializer implements ServletContextListener {
 
     private final PluginManager pluginManager = PluginManager.getInstance();
 
+    private final Config config = ConfigProvider.getConfig();
+
     @Override
     public void contextInitialized(final ServletContextEvent event) {
         LOGGER.info("Loading plugins");
+
+        if (!config.getValue("plugin.external.load.enabled", boolean.class)) {
+            pluginManager.setExternalPluginConfig(true, config.getValue("plugin.external.dir", String.class));
+        }
+
         pluginManager.loadPlugins();
     }
 

apiserver/src/main/java/org/dependencytrack/plugin/PluginIsolatedClassLoader.java

@@ -0,0 +1,126 @@
+/*
+ * This file is part of Dependency-Track.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright (c) OWASP Foundation. All Rights Reserved.
+ */
+package org.dependencytrack.plugin;
+
+import java.io.IOException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * Child-first classloader with configurable shared package prefixes.
+ */
+public final class PluginIsolatedClassLoader extends URLClassLoader {
+
+    private final ClassLoader hostClassLoader;
+    private final List<String> sharedPackagePrefixes;
+
+    /**
+     * @param urls URLs pointing to plugin JAR(s).
+     * @param hostClassLoader classloader to supply shared API classes.
+     * @param sharedPackagePrefixes list of package prefixes that must be loaded from host.
+     */
+    public PluginIsolatedClassLoader(final URL[] urls, final ClassLoader hostClassLoader, final List<String> sharedPackagePrefixes) {
+        super(urls, null);
+        this.hostClassLoader = Objects.requireNonNull(hostClassLoader, "hostClassLoader");
+        this.sharedPackagePrefixes = List.copyOf(Objects.requireNonNull(sharedPackagePrefixes, "sharedPackagePrefixes"));
+    }
+
+    private boolean isShared(final String className) {
+        for (final String prefix : sharedPackagePrefixes) {
+            if (className.startsWith(prefix)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    @Override
+    protected synchronized Class<?> loadClass(final String name, final boolean resolve) throws ClassNotFoundException {
+        // delegate to host
+        if (isShared(name)) {
+            return hostClassLoader.loadClass(name);
+        }
+
+        Class<?> loaded = findLoadedClass(name);
+        if (loaded != null) {
+            if (resolve) {
+                resolveClass(loaded);
+            }
+            return loaded;
+        }
+
+        // Try to load from plugin JAR
+        try {
+            Class<?> clazz = findClass(name);
+            if (resolve) {
+                resolveClass(clazz);
+            }
+            return clazz;
+        } catch (ClassNotFoundException ignored) {
+        }
+
+        // Fallback to host classloader
+        return hostClassLoader.loadClass(name);
+    }
+
+    @Override
+    public URL getResource(final String name) {
+        final String dotted = name.replace('/', '.');
+        for (final String prefix : sharedPackagePrefixes) {
+            if (dotted.startsWith(prefix)) {
+                return hostClassLoader.getResource(name);
+            }
+        }
+
+        final URL url = findResource(name);
+        if (url != null) {
+            return url;
+        }
+        return hostClassLoader.getResource(name);
+    }
+
+    @Override
+    public Enumeration<URL> getResources(final String name) throws IOException {
+        final Enumeration<URL> pluginResources = findResources(name);
+        final Enumeration<URL> hostResources = hostClassLoader.getResources(name);
+
+        return new Enumeration<>() {
+            @Override
+            public boolean hasMoreElements() {
+                return pluginResources.hasMoreElements() || hostResources.hasMoreElements();
+            }
+
+            @Override
+            public URL nextElement() {
+                if (pluginResources.hasMoreElements()) {
+                    return pluginResources.nextElement();
+                }
+                return hostResources.nextElement();
+            }
+        };
+    }
+
+    @Override
+    public void close() throws IOException {
+        super.close();
+    }
+}

apiserver/src/main/java/org/dependencytrack/plugin/PluginManager.java

@@ -32,7 +32,13 @@
 import org.dependencytrack.plugin.api.storage.ExtensionKVStore;
 import org.slf4j.MDC;
 
+import java.io.IOException;
 import java.lang.reflect.Modifier;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -48,8 +54,10 @@
 import java.util.ServiceLoader;
 import java.util.Set;
 import java.util.TreeSet;
+import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.locks.ReentrantLock;
 import java.util.regex.Pattern;
+import java.util.stream.Stream;
 
 import static org.dependencytrack.common.MdcKeys.MDC_EXTENSION;
 import static org.dependencytrack.common.MdcKeys.MDC_EXTENSION_NAME;
@@ -83,6 +91,12 @@ public class PluginManager {
     private final Comparator<ExtensionFactory<?>> factoryComparator;
     private final ReentrantLock lock;
 
+    // Map of each plugin class to its ClassLoader
+    private final Map<Class<?>, ClassLoader> pluginClassToClassLoader = new ConcurrentHashMap<>();
+    private final Map<ClassLoader, Path> externalPluginLoaders = new ConcurrentHashMap<>();
+    private boolean externalPluginsEnabled = false;
+    private Path externalPluginDir;
+
     private PluginManager() {
         this.loadedPluginByClass = new LinkedHashMap<>();
         this.pluginByExtensionIdentity = new HashMap<>();
@@ -244,11 +258,71 @@ private void loadPluginsLocked() {
             }
         }
 
+        if (externalPluginsEnabled) {
+            LOGGER.info("Discovering external plugins in: %s".formatted(externalPluginDir));
+            loadExternalPlugins(externalPluginDir);
+        } else {
+            LOGGER.info("External plugin loading disabled — skipping external scan.");
+        }
+
         determineDefaultExtensions();
 
         assertRequiredExtensionPoints();
     }
 
+    private void loadExternalPlugins(final Path externalPluginDir) {
+        try (Stream<Path> jars = Files.list(externalPluginDir)
+                .filter(path -> path.toString().endsWith(".jar"))) {
+            jars.forEach(this::loadExternalPluginJar);
+        } catch (IOException e) {
+            LOGGER.warn("Failed to scan external plugin directory: %s".formatted(externalPluginDir), e);
+        }
+    }
+
+    private void loadExternalPluginJar(final Path jarPath) {
+        try (var ignoredMdcPlugin = MDC.putCloseable(MDC_PLUGIN, jarPath.getFileName().toString())) {
+
+            final URL jarUrl = jarPath.toUri().toURL();
+
+            // Host classloader to load the Plugin API
+            final ClassLoader hostClassLoader = Plugin.class.getClassLoader();
+
+            // Shared package prefixes
+            final List<String> sharedPackages = List.of(
+                    "org.dependencytrack.plugin.api.",
+                    "org.dependencytrack.plugin."
+            );
+
+            final PluginIsolatedClassLoader loader = new PluginIsolatedClassLoader(
+                    new URL[]{ jarUrl }, hostClassLoader, sharedPackages);
+
+            externalPluginLoaders.put(loader, jarPath);
+            final ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader();
+
+            try {
+                Thread.currentThread().setContextClassLoader(loader);
+
+                final ServiceLoader<Plugin> pluginServiceLoader = ServiceLoader.load(Plugin.class, loader);
+                for (final Plugin plugin : pluginServiceLoader) {
+                    try (var ignored = MDC.putCloseable(MDC_PLUGIN, plugin.getClass().getName())) {
+                        LOGGER.debug("Loading external plugin %s".formatted(plugin.getClass().getName()));
+                        loadExtensionsForPlugin(plugin);
+                        loadedPluginByClass.put(plugin.getClass(), plugin);
+
+                        // Map the plugin class to its loader for unloading
+                        pluginClassToClassLoader.put(plugin.getClass(), loader);
+                        LOGGER.info("External plugin loaded successfully: %s".formatted(plugin.getClass().getName()));
+                    }
+                }
+            } finally {
+                Thread.currentThread().setContextClassLoader(contextClassLoader);
+            }
+
+        } catch (Exception e) {
+            LOGGER.error("Failed to load external plugin from JAR %s".formatted(jarPath), e);
+        }
+    }
+
     private void loadExtensionsForPlugin(final Plugin plugin) {
         final Collection<? extends ExtensionFactory<? extends ExtensionPoint>> extensionFactories = plugin.extensionFactories();
         if (extensionFactories == null || extensionFactories.isEmpty()) {
@@ -433,13 +507,15 @@ void unloadPlugins() {
         lock.lock();
         try {
             unloadPluginsLocked();
+            closeExternalPluginLoaders();
             defaultFactoryByExtensionPointClass.clear();
             factoryByExtensionIdentity.clear();
             extensionNamesByExtensionPointClass.clear();
             specByExtensionPointClass.clear();
             factoriesByPlugin.clear();
             pluginByExtensionIdentity.clear();
             loadedPluginByClass.clear();
+            pluginClassToClassLoader.clear();
         } finally {
             lock.unlock();
         }
@@ -485,4 +561,25 @@ private void unloadPlugin(final Plugin plugin) {
         }
     }
 
+    private void closeExternalPluginLoaders() {
+        // Close all external loaders if any
+        for (ClassLoader loader : new ArrayList<>(externalPluginLoaders.keySet())) {
+            try {
+                if (loader instanceof PluginIsolatedClassLoader) {
+                    ((PluginIsolatedClassLoader) loader).close();
+                } else if (loader instanceof URLClassLoader) {
+                    ((URLClassLoader) loader).close();
+                }
+            } catch (IOException e) {
+                LOGGER.warn("Failed to close plugin classloader for %s: %s".formatted(externalPluginLoaders.get(loader), e.getMessage()));
+            } finally {
+                externalPluginLoaders.remove(loader);
+            }
+        }
+    }
+
+    public void setExternalPluginConfig(boolean enabled, String directory) {
+        this.externalPluginsEnabled = enabled;
+        this.externalPluginDir = Paths.get(directory);
+    }
 }

apiserver/src/main/resources/application.properties

@@ -1669,4 +1669,7 @@ file.storage.extension.s3.enabled=false
 # @default:      5
 # @type:         integer
 # @valid-values: [-7..22]
-# file.storage.extension.s3.compression.level=
+# file.storage.extension.s3.compression.level=
+
+plugin.external.load.enabled=false
+plugin.external.dir= org/dependencytrack/plugin/external/