Add Dockerfile; add command line parsing (#182)

* add a Dockerfile
* added command-line parsing
* updated documentation

---------

Co-authored-by: Reinoud van Leeuwen <reinoud.van.leeuwen@itcreation.nl>

Author: reinoud

Dockerfile

@@ -0,0 +1,10 @@
+# Use an official Python runtime as a parent image
+FROM python:3.11-slim-buster
+
+COPY . /
+
+# Install ssllabsscan module
+RUN pip3 install .
+COPY sample/styles.css /usr/local/lib/python3.11/site-packages/ssllabsscan/styles.css
+
+ENTRYPOINT  [ "ssllabs-scan" ]

README.md

@@ -65,6 +65,23 @@ pip install -e .
 ssllabs-scan sample\SampleServerList.txt
 ```
 
+### Docker
+```
+# Build docker image
+docker build . --tag=ssllabsscan
+```
+Running Docker from commandline:
+```
+# create directory for input and output
+mkdir out
+# put serverlist in directory
+cp SampleServerlist.txt out
+# Run docker image with created directory mounted as /tmp
+# use -t option to prevent output buffering
+docker run --mount type=bind,source=./out,target=/tmp ssllabsscan  -o /tmp/output.html -s /tmp/output.csv /tmp/SampleServerList.txt
+# all html, csv, json output is in the out directory
+```
+
 ### Example console output
 ```
 $ ssllabs-scan sample/SampleServerList.txt

ssllabsscan/main.py

@@ -1,6 +1,7 @@
 """
 App's main
 """
+import argparse
 import csv
 import os
 import shutil
@@ -57,7 +58,7 @@ def process(
         content = f.readlines()
     servers = [x.strip() for x in content if x.strip()]
 
-    with open(SUMMARY_CSV, "w") as outfile:
+    with open(summary_csv, "w") as outfile:
         # write column names to file
         outfile.write("#{}\n".format(",".join(str(s) for s in SUMMARY_COL_NAMES)))
 
@@ -72,15 +73,44 @@ def process(
     output_summary_html(summary_csv, summary_html)
     return ret
 
+def parse_args():
+    """
+    Parse command line arguments.
+    """
+    parser = argparse.ArgumentParser(description="SSL Labs Scan")
+    parser.add_argument(
+        "inputfile",
+        help="Input file containing list of servers to scan",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        dest="output",
+        default=SUMMARY_HTML,
+        help="Output file containing summary of scan results",
+    )
+    parser.add_argument(
+        "-s",
+        "--summary",
+        dest="summary",
+        default=SUMMARY_CSV,
+        help="Output file containing summary of scan results",
+    )
+    parser.add_argument(
+        "-p",
+        "--progress",
+        dest="progress",
+        default=30,
+        help="Progress check interval in seconds",
+    )
+    return parser.parse_args()
 
 def main():
     """
     Entry point of the app.
     """
-    if len(sys.argv) != 2:
-        print(f"{sys.argv[0]} [SERVER_LIST_FILE]")
-        return 1
-    return process(server_list_file=sys.argv[1])
+    args = parse_args()
+    return process(server_list_file=args.inputfile, check_progress_interval_secs=args.progress, summary_csv=args.summary, summary_html=args.output)
 
 
 if __name__ == "__main__":