Merge pull request #41 from RUB-NDS/GUIRework

ic0ns · web-flow · commit 5592de58133f · 2018-09-28T08:16:59.000Z
Gui rework
diff --git a/pom.xml b/pom.xml
@@ -22,6 +22,11 @@
             <version>4.12</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>me.tongfei</groupId>
+            <artifactId>progressbar</artifactId>
+            <version>0.7.1</version>
+        </dependency>
     </dependencies>
     <profiles>
         <profile>
diff --git a/src/main/java/de/rub/nds/tlsscanner/ConsoleLogger.java b/src/main/java/de/rub/nds/tlsscanner/ConsoleLogger.java
@@ -0,0 +1,23 @@
+/**
+ * TLS-Attacker - A Modular Penetration Testing Framework for TLS
+ *
+ * Copyright 2014-2017 Ruhr University Bochum / Hackmanit GmbH
+ *
+ * Licensed under Apache License 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+package de.rub.nds.tlsscanner;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+/**
+ *
+ * @author robert
+ */
+public class ConsoleLogger {
+    public static final Logger CONSOLE = LogManager.getLogger("ConsoleLogger");
+
+    private ConsoleLogger() {
+    }
+}
diff --git a/src/main/java/de/rub/nds/tlsscanner/Main.java b/src/main/java/de/rub/nds/tlsscanner/Main.java
@@ -13,6 +13,7 @@
 import de.rub.nds.tlsattacker.core.config.delegate.GeneralDelegate;
 import de.rub.nds.tlsattacker.core.exceptions.ConfigurationException;
 import de.rub.nds.tlsscanner.config.ScannerConfig;
+import de.rub.nds.tlsscanner.constants.AnsiEscapeSequence;
 import de.rub.nds.tlsscanner.report.SiteReport;
 import java.io.IOException;
 import org.apache.logging.log4j.LogManager;
@@ -41,8 +42,12 @@ public static void main(String[] args) throws IOException {
                 long time = System.currentTimeMillis();
                 LOGGER.info("Performing Scan, this may take some time...");
                 SiteReport report = scanner.scan();
-                LOGGER.info("Scanned in:" + ((System.currentTimeMillis() - time) / 1000) + "s");
-                LOGGER.info(report.getFullReport(config.getReportDetail()));
+                LOGGER.info("Scanned in:" + ((System.currentTimeMillis()-time)/1000) + "s\n");
+                if(!config.getGeneralDelegate().isDebug()){
+                    // ANSI escape sequences to erase the progressbar
+                    ConsoleLogger.CONSOLE.info(AnsiEscapeSequence.ANSI_ONE_LINE_UP + AnsiEscapeSequence.ANSI_ERASE_LINE);
+                }
+                ConsoleLogger.CONSOLE.info("Scanned in: " + ((System.currentTimeMillis()-time)/1000) + "s\n" + report.getFullReport(config.getReportDetail()));
             } catch (ConfigurationException E) {
                 LOGGER.info("Encountered a ConfigurationException aborting.");
                 LOGGER.warn(E);
diff --git a/src/main/java/de/rub/nds/tlsscanner/MultiThreadedScanJobExecutor.java b/src/main/java/de/rub/nds/tlsscanner/MultiThreadedScanJobExecutor.java
@@ -22,6 +22,7 @@
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
+import me.tongfei.progressbar.ProgressBar;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
@@ -44,8 +45,32 @@ public MultiThreadedScanJobExecutor(ExecutorService executor) {
     }
 
     public SiteReport execute(ScannerConfig config, ScanJob scanJob) {
-        List<ProbeType> probeTypes = new LinkedList<>();
 
+        if (config.getGeneralDelegate().isDebug() || config.isNoProgressbar()) {
+            return scan(config, scanJob, null);
+        } else {
+            int numberOfProbes = 0;
+            for (TlsProbe probe : scanJob.getPhaseOneTestList()) {
+                if (probe.getDanger() <= config.getDangerLevel()) {
+                    numberOfProbes++;
+                }
+            }
+            for (TlsProbe probe : scanJob.getPhaseTwoTestList()) {
+                if (probe.getDanger() <= config.getDangerLevel()) {
+                    numberOfProbes++;
+                }
+            }
+            try (ProgressBar pb = new ProgressBar("", numberOfProbes)) {
+                return scan(config, scanJob, pb);
+            }
+        }
+    }
+
+    private SiteReport scan(ScannerConfig config, ScanJob scanJob, ProgressBar pb) {
+        List<ProbeType> probeTypes = new LinkedList<>();
+        if (pb != null) {
+            pb.setExtraMessage("Executing Probes");
+        }
         List<Future<ProbeResult>> futureResults = new LinkedList<>();
         for (TlsProbe probe : scanJob.getPhaseOneTestList()) {
             if (probe.getDanger() <= config.getDangerLevel()) {
@@ -54,6 +79,9 @@ public SiteReport execute(ScannerConfig config, ScanJob scanJob) {
             }
         }
         List<ProbeResult> resultList = new LinkedList<>();
+
+        checkProbesDone(futureResults, pb);
+
         for (Future<ProbeResult> probeResult : futureResults) {
             try {
                 resultList.add(probeResult.get());
@@ -88,10 +116,16 @@ public SiteReport execute(ScannerConfig config, ScanJob scanJob) {
                     ProbeResult result = probe.getNotExecutedResult();
                     if (result != null) {
                         resultList.add(result);
+                        if (pb != null) {
+                            pb.step();
+                        }
                     }
                 }
             }
         }
+
+        checkProbesDone(futureResults, pb);
+
         for (Future<ProbeResult> probeResult : futureResults) {
             try {
                 resultList.add(probeResult.get());
@@ -109,9 +143,34 @@ public SiteReport execute(ScannerConfig config, ScanJob scanJob) {
         for (AfterProbe afterProbe : scanJob.getAfterProbes()) {
             afterProbe.analyze(report);
         }
+        executor.shutdown();
+        LOGGER.info("Finished scan for: " + hostname);
         return report;
     }
 
+    private void checkProbesDone(List<Future<ProbeResult>> futureResults, ProgressBar pb) {
+        boolean isNotReady = true;
+        int done = 0;
+        int tempDone = 0;
+        while (isNotReady) {
+            tempDone = 0;
+            for (Future<ProbeResult> probeResult : futureResults) {
+                if (probeResult.isDone()) {
+                    tempDone++;
+                }
+                if (done < tempDone) {
+                    if (pb != null) {
+                        pb.step();
+                    }
+                    done = tempDone;
+                    if (done == futureResults.size()) {
+                        isNotReady = false;
+                    }
+                }
+            }
+        }
+    }
+
     @Override
     public void shutdown() {
         executor.shutdown();
diff --git a/src/main/java/de/rub/nds/tlsscanner/SingleThreadedScanJobExecutor.java b/src/main/java/de/rub/nds/tlsscanner/SingleThreadedScanJobExecutor.java
@@ -19,6 +19,7 @@
 import java.util.List;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import me.tongfei.progressbar.*;
 
 /**
  *
@@ -30,16 +31,54 @@ public class SingleThreadedScanJobExecutor extends ScanJobExecutor {
 
     public SingleThreadedScanJobExecutor() {
     }
+    
+    private String getPaddedProbeName( String probeName){
+        StringBuilder sb = new StringBuilder(probeName);
+        while(sb.length() < 30){
+            sb.append(" ");
+        }
+        return sb.toString();
+    }
 
     @Override
     public SiteReport execute(ScannerConfig config, ScanJob scanJob) {
+        
+        if(config.getGeneralDelegate().isDebug() || config.isNoProgressbar()){
+            return scan(config, scanJob, null);
+        } else {
+            int numberOfProbes = 0;
+            for (TlsProbe probe : scanJob.getPhaseOneTestList()) {
+                if (probe.getDanger() <= config.getDangerLevel()) {
+                    numberOfProbes++;
+                }
+            }
+            for (TlsProbe probe : scanJob.getPhaseTwoTestList()) {
+                if (probe.getDanger() <= config.getDangerLevel()) {
+                    numberOfProbes++;
+                }
+            }
+            try(ProgressBar pb = new ProgressBar("", numberOfProbes)){
+                return scan(config, scanJob, pb);
+            }
+        }
+        
+            
+    }
+    
+    private SiteReport scan(ScannerConfig config, ScanJob scanJob, ProgressBar pb){
         List<ProbeType> probeTypes = new LinkedList<>();
-
         List<ProbeResult> resultList = new LinkedList<>();
+        
         for (TlsProbe probe : scanJob.getPhaseOneTestList()) {
             if (probe.getDanger() <= config.getDangerLevel()) {
                 try {
+                    if(pb != null){
+                        pb.setExtraMessage("Executing " + getPaddedProbeName(probe.getProbeName()));
+                    }
                     resultList.add(probe.call());
+                    if(pb != null){
+                        pb.step();
+                    }
                 } catch (Exception E) {
                     LOGGER.warn("Could not execute Probe", E);
                 }
@@ -65,20 +104,28 @@ public SiteReport execute(ScannerConfig config, ScanJob scanJob) {
             probe.adjustConfig(report);
         }
         resultList = new LinkedList<>();
-        resultList = new LinkedList<>();
         for (TlsProbe probe : scanJob.getPhaseTwoTestList()) {
             if (probe.getDanger() <= config.getDangerLevel()) {
                 probeTypes.add(probe.getType());
                 if (probe.shouldBeExecuted(report)) {
                     try {
+                        if(pb != null){
+                            pb.setExtraMessage("Executing " + getPaddedProbeName(probe.getProbeName()));
+                        }
                         resultList.add(probe.call());
+                        if(pb != null){
+                            pb.step();
+                        }
                     } catch (Exception E) {
                         LOGGER.warn("Could not execute Probe", E);
                     }
                 } else if (!config.isImplementation()) {
                     ProbeResult result = probe.getNotExecutedResult();
                     if (result != null) {
                         resultList.add(result);
+                        if(pb != null){
+                            pb.step();
+                        }
                     }
                 }
             }
@@ -95,6 +142,7 @@ public SiteReport execute(ScannerConfig config, ScanJob scanJob) {
         for (AfterProbe afterProbe : scanJob.getAfterProbes()) {
             afterProbe.analyze(report);
         }
+        LOGGER.info("Finished scan for: " + hostname);
         return report;
     }
 
diff --git a/src/main/java/de/rub/nds/tlsscanner/config/ScannerConfig.java b/src/main/java/de/rub/nds/tlsscanner/config/ScannerConfig.java
@@ -52,6 +52,8 @@ public class ScannerConfig extends TLSDelegateConfig {
     @Parameter(names = "-aggressiv", required = false, description = "The level of concurrent handshakes (only applies to some resource intensive tests)")
     private int aggroLevel = 1;
 
+    private boolean noProgressbar = false;
+
     @ParametersDelegate
     private StarttlsDelegate starttlsDelegate;
 
@@ -65,6 +67,14 @@ public ScannerConfig(GeneralDelegate delegate) {
         addDelegate(starttlsDelegate);
     }
 
+    public boolean isNoProgressbar() {
+        return noProgressbar;
+    }
+
+    public void setNoProgressbar(boolean noProgressbar) {
+        this.noProgressbar = noProgressbar;
+    }
+
     public int getAggroLevel() {
         return aggroLevel;
     }
diff --git a/src/main/java/de/rub/nds/tlsscanner/constants/AnsiEscapeSequence.java b/src/main/java/de/rub/nds/tlsscanner/constants/AnsiEscapeSequence.java
@@ -0,0 +1,16 @@
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package de.rub.nds.tlsscanner.constants;
+
+/**
+ *
+ * @author Pierre Tilhaus<pierre.tilhaus@rub.de>
+ */
+public class AnsiEscapeSequence {
+    
+    public static final String ANSI_ONE_LINE_UP = "\033[1A";
+    public static final String ANSI_ERASE_LINE = "\033[2K";
+}
diff --git a/src/main/java/de/rub/nds/tlsscanner/report/SiteReportPrinter.java b/src/main/java/de/rub/nds/tlsscanner/report/SiteReportPrinter.java
diff --git a/src/main/resources/log4j2.xml b/src/main/resources/log4j2.xml
