Support additional Nmap command line options

PiperOrigin-RevId: 630301045
Change-Id: If5a9be16d708bc2897cfa2d1e39b00ab3c03b36b

google/portscan/nmap/src/main/java/com/google/tsunami/plugins/portscan/nmap/NmapPortScanner.java

@@ -117,6 +117,7 @@ public PortScanningReport scan(ScanTarget scanTarget) {
               .withScript("http-methods", "http.useragent=" + httpClientCliOptions.userAgent)
               .withTimingTemplate(TimingTemplate.AGGRESSIVE)
               .withTargetNetworkEndpoint(scanTarget.getNetworkEndpoint())
+              .withExtraCommandLineOptions(cliOptions.nmapCmdOpts)
               .run(commandExecutor);
       logger.atInfo().log(
           "Finished nmap scan on target '%s' in %s.",

google/portscan/nmap/src/main/java/com/google/tsunami/plugins/portscan/nmap/client/NmapClient.java

@@ -21,6 +21,7 @@
 
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.ImmutableList;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.tsunami.common.command.CommandExecutor;
 import com.google.tsunami.common.command.CommandExecutorFactory;
 import com.google.tsunami.common.data.NetworkEndpointUtils;
@@ -191,6 +192,7 @@ Optional<String> getFlag() {
   }
 
   private final String nmapBinaryPath;
+  private final List<String> extraCommandArgs = new ArrayList<>();
   private final List<NetworkEndpoint> networkEndpoints = new ArrayList<>();
   private final List<HostDiscoveryTechnique> hostDiscoveryTechniques = new ArrayList<>();
   private final List<String> dnsServers = new ArrayList<>();
@@ -321,6 +323,10 @@ ArrayList<String> buildRunCommandArgs() {
       runCommandArgs.add("-6");
     }
 
+    if (extraCommandArgs != null) {
+      runCommandArgs.addAll(extraCommandArgs);
+    }
+
     networkEndpoints.stream()
         .map(NmapClient::networkEndpointToCliRepresentation)
         .forEach(runCommandArgs::add);
@@ -354,6 +360,20 @@ public NmapClient withTargetNetworkEndpoint(NetworkEndpoint networkEndpoint) {
     return this;
   }
 
+  /**
+   * Sets additional command line options for the Nmap scanning. They are appended at the end of
+   * nmap command invocation, right before the targets.
+   *
+   * @param commandArgs The extra command line options.
+   */
+  @CanIgnoreReturnValue
+  public NmapClient withExtraCommandLineOptions(List<String> commandArgs) {
+    if (commandArgs != null) {
+      this.extraCommandArgs.addAll(commandArgs);
+    }
+    return this;
+  }
+
   /**
    * Skips the host discovery stage, this causes nmap to perform scanning even if the host is dead.
    * This method is incompatible with {@link

google/portscan/nmap/src/main/java/com/google/tsunami/plugins/portscan/nmap/option/NmapPortScannerCliOptions.java

@@ -38,6 +38,11 @@ public final class NmapPortScannerCliOptions implements CliOption {
   // Splitting and conversion is done by the NmapPortScanner itself.
   public String portRangesTarget;
 
+  @Parameter(
+      names = "--nmap-cmd-opts",
+      description = "Additional command line options for Nmap scanning.")
+  public List<String> nmapCmdOpts;
+
   @Override
   public void validate() {}
 }

google/portscan/nmap/src/test/java/com/google/tsunami/plugins/portscan/nmap/client/NmapClientTest.java

@@ -22,6 +22,7 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
+import com.google.common.collect.ImmutableList;
 import com.google.tsunami.common.command.CommandExecutor;
 import com.google.tsunami.common.command.CommandExecutorFactory;
 import com.google.tsunami.common.data.NetworkEndpointUtils;
@@ -353,6 +354,32 @@ public void buildRunCommandArgs_withMultipleScript_returnsCorrectCommandLine() {
             report.getAbsolutePath());
   }
 
+  @Test
+  public void buildRunCommandArgs_withExtraCommandLineArgs_returnsCorrectCommandLine() {
+    client
+        .withTargetNetworkEndpoint(NetworkEndpointUtils.forIp("1.1.1.1"))
+        .withExtraCommandLineOptions(ImmutableList.of("--foo", "--bar"))
+        .withScript("test1", "a", "b")
+        .withScript("test2", "e", "f");
+
+    assertThat(client.buildRunCommandArgs())
+        .containsExactly(
+            nmapFile.getAbsolutePath(),
+            "--script",
+            "test1",
+            "--script-args",
+            "a,b",
+            "--script",
+            "test2",
+            "--script-args",
+            "e,f",
+            "--foo",
+            "--bar",
+            "1.1.1.1",
+            "-oX",
+            report.getAbsolutePath());
+  }
+
   @Test
   public void getResults_onceClientHasRan_returnsNmapRunReport()
       throws IOException, ExecutionException, InterruptedException, ParserConfigurationException,