Merge branch 'main' into test/passive-package-coverage

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 -->
@@ -279,6 +277,9 @@
             <plugin>
                 <groupId>com.github.spotbugs</groupId>
                 <artifactId>spotbugs-maven-plugin</artifactId>
+                <configuration>
+                    <excludeFilterFile>${project.basedir}/spotbugs-exclude.xml</excludeFilterFile>
+                </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

spotbugs-exclude.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<FindBugsFilter>
+    <!-- Exclude EI_EXPOSE_REP and EI_EXPOSE_REP2 globally -->
+    <Match>
+        <Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
+    </Match>
+</FindBugsFilter>

src/main/java/de/rub/nds/scanner/core/config/ExecutorConfig.java

@@ -66,108 +66,233 @@ public ExecutorConfig() {
         // Default constructor
     }
 
+    /**
+     * Returns a copy of the list of probe types that are excluded from scanning.
+     *
+     * @return a new list containing the excluded probe types
+     */
     public List<ProbeType> getExcludedProbes() {
         return new LinkedList<>(excludedProbes);
     }
 
+    /**
+     * Sets the list of probe types to be excluded from scanning.
+     *
+     * @param excludedProbes the list of probe types to exclude
+     */
     public void setExcludedProbes(List<ProbeType> excludedProbes) {
         this.excludedProbes = new LinkedList<>(excludedProbes);
     }
 
+    /**
+     * Returns the scanner detail level for the scan operation.
+     *
+     * @return the current scanner detail level
+     */
     public ScannerDetail getScanDetail() {
         return scanDetail;
     }
 
+    /**
+     * Sets the scanner detail level for the scan operation.
+     *
+     * @param scanDetail the scanner detail level to set
+     */
     public void setScanDetail(ScannerDetail scanDetail) {
         this.scanDetail = scanDetail;
     }
 
+    /**
+     * Returns the scanner detail level for post-analysis operations.
+     *
+     * @return the current post-analysis detail level
+     */
     public ScannerDetail getPostAnalysisDetail() {
         return postAnalysisDetail;
     }
 
+    /**
+     * Sets the scanner detail level for post-analysis operations.
+     *
+     * @param postAnalysisDetail the post-analysis detail level to set
+     */
     public void setPostAnalysisDetail(ScannerDetail postAnalysisDetail) {
         this.postAnalysisDetail = postAnalysisDetail;
     }
 
+    /**
+     * Returns the scanner detail level for report generation.
+     *
+     * @return the current report detail level
+     */
     public ScannerDetail getReportDetail() {
         return reportDetail;
     }
 
+    /**
+     * Sets the scanner detail level for report generation.
+     *
+     * @param reportDetail the report detail level to set
+     */
     public void setReportDetail(ScannerDetail reportDetail) {
         this.reportDetail = reportDetail;
     }
 
+    /**
+     * Checks if colored text output is disabled.
+     *
+     * @return true if colored text is disabled, false otherwise
+     */
     public boolean isNoColor() {
         return noColor;
     }
 
+    /**
+     * Sets whether colored text output should be disabled.
+     *
+     * @param noColor true to disable colored text, false to enable it
+     */
     public void setNoColor(boolean noColor) {
         this.noColor = noColor;
     }
 
+    /**
+     * Returns a copy of the list of probe types to be executed.
+     *
+     * @return a new list containing the probe types, or null if not set
+     */
     public List<ProbeType> getProbes() {
         return probes == null ? null : new LinkedList<>(probes);
     }
 
+    /**
+     * Sets the list of probe types to be executed.
+     *
+     * @param probes the list of probe types to execute, or null to clear
+     */
     public void setProbes(List<ProbeType> probes) {
         this.probes = probes == null ? null : new LinkedList<>(probes);
     }
 
+    /**
+     * Sets the probe types to be executed using a varargs parameter.
+     *
+     * @param probes the probe types to execute
+     */
     public void setProbes(ProbeType... probes) {
         this.probes = Arrays.asList(probes);
     }
 
+    /**
+     * Adds additional probe types to the existing list of probes to be executed.
+     *
+     * @param probes the list of probe types to add
+     */
     public void addProbes(List<ProbeType> probes) {
         if (this.probes == null) {
             this.probes = new LinkedList<>();
         }
         this.probes.addAll(probes);
     }
 
+    /**
+     * Adds additional probe types to the existing list using a varargs parameter.
+     *
+     * @param probes the probe types to add
+     */
     public void addProbes(ProbeType... probes) {
         if (this.probes == null) {
             this.probes = new LinkedList<>();
         }
         this.probes.addAll(Arrays.asList(probes));
     }
 
+    /**
+     * Returns the timeout value for each probe execution in milliseconds.
+     *
+     * @return the probe timeout in milliseconds
+     */
     public int getProbeTimeout() {
         return probeTimeout;
     }
 
+    /**
+     * Sets the timeout value for each probe execution in milliseconds.
+     *
+     * @param probeTimeout the probe timeout in milliseconds
+     */
     public void setProbeTimeout(int probeTimeout) {
         this.probeTimeout = probeTimeout;
     }
 
+    /**
+     * Checks if the report should be written to a file.
+     *
+     * @return true if an output file is specified, false otherwise
+     */
     public boolean isWriteReportToFile() {
         return outputFile != null;
     }
 
+    /**
+     * Returns the path to the output file for the report.
+     *
+     * @return the output file path, or null if not specified
+     */
     public String getOutputFile() {
         return outputFile;
     }
 
+    /**
+     * Sets the path to the output file for the report.
+     *
+     * @param outputFile the output file path
+     */
     public void setOutputFile(String outputFile) {
         this.outputFile = outputFile;
     }
 
+    /**
+     * Returns the number of threads used for executing different probes in parallel.
+     *
+     * @return the number of parallel probe threads
+     */
     public int getParallelProbes() {
         return parallelProbes;
     }
 
+    /**
+     * Sets the number of threads used for executing different probes in parallel.
+     *
+     * @param parallelProbes the number of parallel probe threads
+     */
     public void setParallelProbes(int parallelProbes) {
         this.parallelProbes = parallelProbes;
     }
 
+    /**
+     * Returns the maximum number of threads used to execute probes.
+     *
+     * @return the maximum number of overall threads
+     */
     public int getOverallThreads() {
         return overallThreads;
     }
 
+    /**
+     * Sets the maximum number of threads used to execute probes.
+     *
+     * @param overallThreads the maximum number of overall threads
+     */
     public void setOverallThreads(int overallThreads) {
         this.overallThreads = overallThreads;
     }
 
+    /**
+     * Checks if the scanner is configured to run in multithreaded mode.
+     *
+     * @return true if either parallel probes or overall threads is greater than 1
+     */
     public boolean isMultithreaded() {
         return parallelProbes > 1 || overallThreads > 1;
     }

src/main/java/de/rub/nds/scanner/core/config/ScannerDetail.java

@@ -20,10 +20,21 @@ public enum ScannerDetail {
         this.levelValue = levelValue;
     }
 
+    /**
+     * Returns the numeric level value associated with this scanner detail level.
+     *
+     * @return the level value as an integer
+     */
     public int getLevelValue() {
         return levelValue;
     }
 
+    /**
+     * Checks if this scanner detail level is greater than or equal to the specified detail level.
+     *
+     * @param detail the scanner detail level to compare against
+     * @return true if this level is greater than or equal to the specified level, false otherwise
+     */
     public boolean isGreaterEqualTo(ScannerDetail detail) {
         return levelValue >= detail.getLevelValue();
     }

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

@@ -12,16 +12,32 @@
 import java.util.concurrent.ThreadFactory;
 import java.util.concurrent.atomic.AtomicInteger;
 
+/**
+ * A thread factory that creates threads with custom names. This factory is useful for identifying
+ * threads in thread dumps and monitoring tools.
+ */
 public class NamedThreadFactory implements ThreadFactory {
 
     private AtomicInteger number = new AtomicInteger(1);
 
     private final String prefix;
 
+    /**
+     * Creates a new NamedThreadFactory with the specified name prefix.
+     *
+     * @param prefix the prefix to use for thread names. Threads will be named as "prefix-number"
+     */
     public NamedThreadFactory(String prefix) {
         this.prefix = prefix;
     }
 
+    /**
+     * Creates a new thread with a custom name. The thread name will be in the format
+     * "prefix-number" where number increments for each new thread.
+     *
+     * @param r the runnable to be executed by the new thread
+     * @return a newly created thread with a custom name
+     */
     @Override
     public Thread newThread(Runnable r) {
         Thread newThread = Executors.defaultThreadFactory().newThread(r);

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

@@ -14,6 +14,15 @@
 import java.util.LinkedList;
 import java.util.List;
 
+/**
+ * Represents a collection of probes and after-probes to be executed during a scan. A scan job
+ * encapsulates the work to be performed as part of a scanning operation.
+ *
+ * @param <ReportT> the type of scan report
+ * @param <ProbeT> the type of scanner probe
+ * @param <AfterProbeT> the type of after-probe
+ * @param <StateT> the type of state object used by probes
+ */
 public class ScanJob<
         ReportT extends ScanReport,
         ProbeT extends ScannerProbe<ReportT, StateT>,
@@ -23,15 +32,31 @@ public class ScanJob<
     private final List<ProbeT> probeList;
     private final List<AfterProbeT> afterList;
 
+    /**
+     * Creates a new scan job with the specified probes and after-probes.
+     *
+     * @param probeList the list of probes to execute
+     * @param afterList the list of after-probes to execute after all probes complete
+     */
     public ScanJob(List<ProbeT> probeList, List<AfterProbeT> afterList) {
         this.probeList = new LinkedList<>(probeList);
         this.afterList = new LinkedList<>(afterList);
     }
 
+    /**
+     * Returns a copy of the probe list.
+     *
+     * @return a new list containing all probes in this scan job
+     */
     public List<ProbeT> getProbeList() {
         return new LinkedList<>(probeList);
     }
 
+    /**
+     * Returns a copy of the after-probe list.
+     *
+     * @return a new list containing all after-probes in this scan job
+     */
     public List<AfterProbeT> getAfterList() {
         return new LinkedList<>(afterList);
     }