Merge branch 'main' into fix-obl-unsatisfied-obligation-scanner

# Conflicts:
#	src/test/java/de/rub/nds/scanner/core/execution/ScannerTest.java

Author: TrueSkrillor

.github/dependabot.yml

@@ -13,3 +13,7 @@ updates:
       interval: "daily"
     open-pull-requests-limit: 20
     registries: "*"
+    groups:
+      internal:
+        patterns:
+          - "de.rub.nds*"

pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>de.rub.nds</groupId>
         <artifactId>protocol-toolkit-bom</artifactId>
-        <version>6.0.1</version>
+        <version>6.2.1</version>
     </parent>
 
     <artifactId>scanner-core</artifactId>
@@ -145,7 +145,7 @@
                             <spacesPerTab>4</spacesPerTab>
                         </indent>
                         <googleJavaFormat>
-                            <version>1.25.2</version>
+                            <version>${plugin.spotless-maven-plugin.google-java-format.version}</version>
                             <style>AOSP</style>
                         </googleJavaFormat>
                         <licenseHeader>
@@ -185,9 +185,7 @@
                 <configuration>
                     <source>${maven.compiler.source}</source>
                     <target>${maven.compiler.target}</target>
-                    <compilerArgs>
-                        <compilerArg>-proc:full</compilerArg>
-                    </compilerArgs>
+                    <proc>full</proc>
                 </configuration>
             </plugin>
             <!-- Execute unit tests -->

src/main/java/de/rub/nds/scanner/core/execution/ScannerThreadPoolExecutor.java

@@ -8,21 +8,23 @@
  */
 package de.rub.nds.scanner.core.execution;
 
+import java.util.List;
+import java.util.Timer;
+import java.util.TimerTask;
 import java.util.concurrent.Callable;
 import java.util.concurrent.Future;
 import java.util.concurrent.RejectedExecutionHandler;
 import java.util.concurrent.ScheduledThreadPoolExecutor;
 import java.util.concurrent.Semaphore;
 import java.util.concurrent.ThreadFactory;
 import java.util.concurrent.ThreadPoolExecutor;
-import java.util.concurrent.TimeUnit;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
 /**
  * Extends {@link ThreadPoolExecutor} with its own afterExecute function. A
  * ScannerThreadPoolExecutor hold a semaphore which is released each time a Thread finished
- * executing.
+ * executing or is aborted on timeout.
  */
 public class ScannerThreadPoolExecutor extends ScheduledThreadPoolExecutor {
 
@@ -35,6 +37,8 @@ public class ScannerThreadPoolExecutor extends ScheduledThreadPoolExecutor {
     /** The time after which tasks are automatically cancelled */
     private final long timeout;
 
+    private final Timer timer;
+
     /**
      * Call super and assign the semaphore
      *
@@ -50,6 +54,7 @@ public ScannerThreadPoolExecutor(
         this.timeout = timeout;
         this.setContinueExistingPeriodicTasksAfterShutdownPolicy(false);
         this.setExecuteExistingDelayedTasksAfterShutdownPolicy(false);
+        this.timer = new Timer();
     }
 
     /**
@@ -84,6 +89,7 @@ public Future<?> submit(Runnable task) {
      * @param result the result to return when the task completes
      * @return a Future representing pending completion of the task
      */
+    @Override
     public <T> Future<T> submit(Runnable task, T result) {
         Future<T> future = super.submit(task, result);
         cancelFuture(future);
@@ -98,28 +104,48 @@ public <T> Future<T> submit(Runnable task, T result) {
      * @param task the task to submit
      * @return a Future representing pending completion of the task
      */
+    @Override
     public <T> Future<T> submit(Callable<T> task) {
         Future<T> future = super.submit(task);
         cancelFuture(future);
         return future;
     }
 
+    @Override
+    public void shutdown() {
+        super.shutdown();
+        timer.cancel();
+    }
+
+    @Override
+    public List<Runnable> shutdownNow() {
+        timer.cancel();
+        return super.shutdownNow();
+    }
+
+    @Override
+    public void close() {
+        super.close();
+        timer.cancel();
+    }
+
     private void cancelFuture(Future<?> future) {
-        this.schedule(
-                () -> {
-                    if (!future.isDone()) {
-                        future.cancel(true);
-                        if (future.isCancelled()) {
-                            LOGGER.error("Killed task {}", future);
+        timer.schedule(
+                new TimerTask() {
+                    @Override
+                    public void run() {
+                        if (!future.isDone()) {
+                            future.cancel(true);
+                            if (future.isCancelled()) {
+                                LOGGER.error("Killed task {}", future);
+                            } else {
+                                LOGGER.error("Could not kill task {}", future);
+                            }
                         } else {
-                            LOGGER.error("Could not kill task {}", future);
+                            LOGGER.debug("Future already done! {}", future);
                         }
-                    } else {
-                        LOGGER.debug("Future already done! {}", future);
                     }
-                    semaphore.release();
                 },
-                timeout,
-                TimeUnit.MILLISECONDS);
+                timeout);
     }
 }

src/main/java/de/rub/nds/scanner/core/execution/ThreadedScanJobExecutor.java

@@ -20,10 +20,7 @@
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.Future;
-import java.util.concurrent.Semaphore;
-import java.util.concurrent.ThreadPoolExecutor;
+import java.util.concurrent.*;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
@@ -57,7 +54,7 @@ public class ThreadedScanJobExecutor<
     private final ThreadPoolExecutor executor;
 
     // Used for waiting for Threads in the ThreadPoolExecutor
-    private final Semaphore semaphore = new Semaphore(0);
+    private final Semaphore semaphore;
 
     private int probeCount;
     private int finishedProbes = 0;
@@ -76,7 +73,8 @@ public ThreadedScanJobExecutor(
             int threadCount,
             String prefix) {
         long probeTimeout = config.getProbeTimeout();
-        executor =
+        this.semaphore = new Semaphore(0);
+        this.executor =
                 new ScannerThreadPoolExecutor(
                         threadCount, new NamedThreadFactory(prefix), semaphore, probeTimeout);
         this.config = config;
@@ -90,11 +88,14 @@ public ThreadedScanJobExecutor(
      * @param config the executor configuration
      * @param scanJob the scan job containing probes to execute
      * @param executor the thread pool executor to use
+     * @param semaphore the semaphore released by the executor when a probe finishes
      */
     public ThreadedScanJobExecutor(
             ExecutorConfig config,
             ScanJob<ReportT, ProbeT, AfterProbeT, StateT> scanJob,
-            ThreadPoolExecutor executor) {
+            ThreadPoolExecutor executor,
+            Semaphore semaphore) {
+        this.semaphore = semaphore;
         this.executor = executor;
         this.config = config;
         this.scanJob = scanJob;

src/main/java/de/rub/nds/scanner/core/probe/AnalyzedProperty.java

@@ -13,11 +13,12 @@
 import jakarta.xml.bind.annotation.XmlAccessType;
 import jakarta.xml.bind.annotation.XmlAccessorType;
 import jakarta.xml.bind.annotation.XmlRootElement;
+import java.io.Serializable;
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
-public interface AnalyzedProperty {
+public interface AnalyzedProperty extends Serializable {
 
     AnalyzedPropertyCategory getCategory();
 

src/main/java/de/rub/nds/scanner/core/probe/AnalyzedPropertyCategory.java

@@ -11,7 +11,8 @@
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import jakarta.xml.bind.annotation.XmlAccessType;
 import jakarta.xml.bind.annotation.XmlAccessorType;
+import java.io.Serializable;
 
 @XmlAccessorType(XmlAccessType.FIELD)
 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
-public interface AnalyzedPropertyCategory {}
+public interface AnalyzedPropertyCategory extends Serializable {}

src/main/java/de/rub/nds/scanner/core/probe/ProbeTypeConverter.java

@@ -9,6 +9,7 @@
 package de.rub.nds.scanner.core.probe;
 
 import com.beust.jcommander.IStringConverter;
+import java.lang.reflect.InvocationTargetException;
 import java.util.Set;
 import java.util.stream.Collectors;
 import org.reflections.Reflections;
@@ -46,7 +47,10 @@ public ProbeType convert(String value) {
                 if (convertedType != null) {
                     return convertedType;
                 }
-            } catch (Exception ignored) {
+            } catch (NoSuchMethodException
+                    | IllegalAccessException
+                    | IllegalArgumentException
+                    | InvocationTargetException ignored) {
                 // Ignore conversion failures and try next method
             }
         }

src/main/java/de/rub/nds/scanner/core/report/AnalyzedPropertyTextEncoder.java

@@ -11,14 +11,30 @@
 import de.rub.nds.scanner.core.probe.AnalyzedProperty;
 import java.util.HashMap;
 
+/**
+ * An encoder that converts AnalyzedProperty instances to their text representation. Uses a provided
+ * mapping to translate properties to custom strings.
+ */
 public class AnalyzedPropertyTextEncoder extends Encoder<AnalyzedProperty> {
 
     private final HashMap<AnalyzedProperty, String> map;
 
+    /**
+     * Creates a new AnalyzedPropertyTextEncoder with the specified property-to-text mapping.
+     *
+     * @param map a HashMap mapping AnalyzedProperty instances to their string representations
+     */
     public AnalyzedPropertyTextEncoder(HashMap<AnalyzedProperty, String> map) {
         this.map = map;
     }
 
+    /**
+     * Encodes an AnalyzedProperty to its string representation. If a mapping exists, returns the
+     * mapped value; otherwise returns the property's name.
+     *
+     * @param analyzedProperty the property to encode
+     * @return the string representation of the property
+     */
     @Override
     public String encode(AnalyzedProperty analyzedProperty) {
         if (map == null) {

src/main/java/de/rub/nds/scanner/core/report/AnsiColor.java

@@ -11,6 +11,10 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Enum representing ANSI color codes for terminal output. Provides foreground colors, background
+ * colors, and text formatting options.
+ */
 public enum AnsiColor {
     RESET("\u001B[0m"),
     BLACK("\u001B[30m"),
@@ -48,10 +52,21 @@ public enum AnsiColor {
         }
     }
 
+    /**
+     * Returns the AnsiColor corresponding to the given ANSI code string.
+     *
+     * @param code the ANSI code string
+     * @return the corresponding AnsiColor, or null if no match is found
+     */
     public static AnsiColor getAnsiColor(String code) {
         return MAP.get(code);
     }
 
+    /**
+     * Returns the ANSI code string for this color.
+     *
+     * @return the ANSI code string
+     */
     public String getCode() {
         return code;
     }

src/main/java/de/rub/nds/scanner/core/report/AnsiEscapeSequence.java

@@ -8,8 +8,15 @@
  */
 package de.rub.nds.scanner.core.report;
 
+/**
+ * Utility class containing ANSI escape sequences for terminal manipulation. Provides constants for
+ * cursor movement and line manipulation.
+ */
 public class AnsiEscapeSequence {
 
+    /** ANSI escape sequence to move cursor up one line */
     public static final String ANSI_ONE_LINE_UP = "\033[1A";
+
+    /** ANSI escape sequence to erase the current line */
     public static final String ANSI_ERASE_LINE = "\033[2K";
 }