Issue #4989 Prevent parsing of module-info.class in osgi bundles (#4991)

Signed-off-by: Jan Bartel <[email protected]>

jetty-annotations/src/main/java/org/eclipse/jetty/annotations/AnnotationParser.java

@@ -972,7 +972,7 @@ public void resetParsedClasses()
      * @param name the class file name
      * @return whether the class file name is valid
      */
-    private boolean isValidClassFileName(String name)
+    public boolean isValidClassFileName(String name)
     {
         //no name cannot be valid
         if (name == null || name.length() == 0)
@@ -1014,7 +1014,7 @@ private boolean isValidClassFileName(String name)
      * @param path the class file path
      * @return whether the class file path is valid
      */
-    private boolean isValidClassFilePath(String path)
+    public boolean isValidClassFilePath(String path)
     {
         //no path is not valid
         if (path == null || path.length() == 0)

jetty-osgi/jetty-osgi-boot/src/main/java/org/eclipse/jetty/osgi/annotations/AnnotationParser.java

@@ -50,7 +50,7 @@ public class AnnotationParser extends org.eclipse.jetty.annotations.AnnotationPa
 
     public AnnotationParser(int javaPlatform)
     {
-        super(javaPlatform, Opcodes.ASM7);
+        super(javaPlatform);
     }
 
     /**
@@ -60,7 +60,7 @@ public AnnotationParser(int javaPlatform)
      * @return the resource for the bundle
      * @throws Exception if unable to create the resource reference
      */
-    protected Resource indexBundle(Bundle bundle) throws Exception
+    public Resource indexBundle(Bundle bundle) throws Exception
     {
         File bundleFile = BundleFileLocatorHelperFactory.getFactory().getHelper().getBundleInstallLocation(bundle);
         Resource resource = Resource.newResource(bundleFile.toURI());
@@ -114,7 +114,7 @@ public void parse(Set<? extends Handler> handlers, URI[] uris)
         }
     }
 
-    protected void parse(Set<? extends Handler> handlers, Bundle bundle)
+    public void parse(Set<? extends Handler> handlers, Bundle bundle)
         throws Exception
     {
         URI uri = _bundleToUri.get(bundle);
@@ -211,10 +211,17 @@ else if (bundle.getEntry("/target/classes/") != null)
                 //or the bundle classpath wasn't simply ".", so skip it
                 continue;
             }
+
+            if (!isValidClassFileName(name))
+            {
+                continue; //eg skip module-info.class 
+            }
+
             //transform into a classname to pass to the resolver
             String shortName = StringUtil.replace(name, '/', '.').substring(0, name.length() - 6);
 
             addParsedClass(shortName, getResource(bundle));
+
             try (InputStream classInputStream = classUrl.openStream())
             {
                 scanClass(handlers, getResource(bundle), classInputStream);

jetty-osgi/test-jetty-osgi/src/test/java/org/eclipse/jetty/osgi/test/TestJettyOSGiAnnotationParser.java

@@ -0,0 +1,96 @@
+//
+//  ========================================================================
+//  Copyright (c) 1995-2020 Mort Bay Consulting Pty Ltd and others.
+//  ------------------------------------------------------------------------
+//  All rights reserved. This program and the accompanying materials
+//  are made available under the terms of the Eclipse Public License v1.0
+//  and Apache License v2.0 which accompanies this distribution.
+//
+//      The Eclipse Public License is available at
+//      http://www.eclipse.org/legal/epl-v10.html
+//
+//      The Apache License v2.0 is available at
+//      http://www.opensource.org/licenses/apache2.0.php
+//
+//  You may elect to redistribute this code under either of these licenses.
+//  ========================================================================
+//
+
+package org.eclipse.jetty.osgi.test;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.concurrent.ConcurrentHashMap;
+import javax.inject.Inject;
+
+import aQute.bnd.osgi.Constants;
+
+import org.eclipse.jetty.annotations.ClassInheritanceHandler;
+import org.eclipse.jetty.osgi.annotations.AnnotationParser;
+import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.ops4j.pax.exam.Configuration;
+import org.ops4j.pax.exam.CoreOptions;
+import org.ops4j.pax.exam.Option;
+import org.ops4j.pax.exam.junit.PaxExam;
+import org.ops4j.pax.tinybundles.core.TinyBundle;
+import org.ops4j.pax.tinybundles.core.TinyBundles;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+
+import static org.junit.Assert.assertTrue;
+import static org.ops4j.pax.exam.CoreOptions.mavenBundle;
+/**
+ * TestJettyOSGiAnnotationParser
+ *
+ */
+
+@RunWith(PaxExam.class)
+public class TestJettyOSGiAnnotationParser
+{
+    @Inject
+    BundleContext bundleContext = null;
+
+    @Configuration
+    public static Option[] configure()
+    {
+        ArrayList<Option> options = new ArrayList<>();
+        options.add(TestOSGiUtil.optionalRemoteDebug());
+        options.add(CoreOptions.junitBundles());
+        options.addAll(TestOSGiUtil.coreJettyDependencies());
+        options.add(mavenBundle().groupId("biz.aQute.bnd").artifactId("bndlib").versionAsInProject().start());
+        options.add(mavenBundle().groupId("org.ops4j.pax.tinybundles").artifactId("tinybundles").version("2.1.1").start());
+        return options.toArray(new Option[options.size()]);
+    }
+
+    @Test
+    public void testParse() throws Exception
+    {
+        //get a reference to a pre-prepared module-info
+        Path path = Paths.get("src", "test", "resources", "module-info.clazz");
+        File moduleInfo = path.toFile();
+        assertTrue(moduleInfo.exists());
+
+        TinyBundle bundle = TinyBundles.bundle();
+        bundle.set(Constants.BUNDLE_SYMBOLICNAME, "bundle.with.module.info");
+        bundle.add("module-info.class", new FileInputStream(moduleInfo)); //copy it into the fake bundle
+        InputStream is = bundle.build();
+        bundleContext.installBundle("dummyLocation", is);
+
+        //test the osgi annotation parser ignore the module-info.class file in the fake bundle
+        //Get a reference to the deployed fake bundle
+        Bundle b = TestOSGiUtil.getBundle(bundleContext, "bundle.with.module.info");
+        AnnotationParser parser = new AnnotationParser(0);
+        parser.indexBundle(b);
+        ClassInheritanceHandler handler = new ClassInheritanceHandler(new ConcurrentHashMap<>());
+        parser.parse(Collections.singleton(handler), b);
+
+    }
+}

jetty-osgi/test-jetty-osgi/src/test/resources/module-info.java

@@ -0,0 +1,21 @@
+//
+//  ========================================================================
+//  Copyright (c) 1995-2020 Mort Bay Consulting Pty Ltd and others.
+//  ------------------------------------------------------------------------
+//  All rights reserved. This program and the accompanying materials
+//  are made available under the terms of the Eclipse Public License v1.0
+//  and Apache License v2.0 which accompanies this distribution.
+//
+//      The Eclipse Public License is available at
+//      http://www.eclipse.org/legal/epl-v10.html
+//
+//      The Apache License v2.0 is available at
+//      http://www.opensource.org/licenses/apache2.0.php
+//
+//  You may elect to redistribute this code under either of these licenses.
+//  ========================================================================
+//
+
+module com.bubble
+{
+}