Update README.md

SamoKopecky · Aug 9, 2021 · 6636560 · 6636560
1 parent 7140c46
commit 6636560
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,7 @@
 ```
 
 # SSLTest
+Script that scans web servers cryptographic parameters and vulnerabilities 
 
 ## Installation
 
@@ -24,12 +25,36 @@ $ sudo ptmanager -ut SSLTest
 
 ## Options
 ```
-TODO
+-u   --url            <url>  Url to scan, required option
+-p   --port                  Port or ports (separate with spaces) to scan on (default: [443])
+-j   --json                  change output to json format, if a file name is specified output is 
+                             written to the given file
+-t   --test                  test the server for a specified vulnerability
+                             possible vulnerabilities (separate with spaces):
+                                0: No test
+                                1: Heartbleed
+                                2: CCS injection
+                                3: Insecure renegotiation
+                                4: ZombiePOODLE/GOLDENDOOLDE
+                                5: Session ticket support
+                                6: CRIME
+                                7: RC4 support
+                             if this argument isn't specified all tests will be ran
+-fc  --fix-conf              Allow the use of older versions of TLS protocol (TLSv1 and TLSv1.1) 
+                             in order to scan a server which still run on these versions. 
+                             !WARNING!: this may rewrite the contents of a configuration file 
+                             located at /etc/ssl/openssl.cnf
+-ns  --nmap-scan             Use nmap to scan the server version
+-nd  --nmap-discover         Use nmap to discover web server ports
+-i   --info                  Output some internal information about the script functions
+-d   --debug                 Output debug information
+-v   --version               Show script version and exit
+-h   --help                  Show this help message and exit
 ```
 
 ## Usage examples
 ```
-TODO
+$ SSLTest.py -u https://example.com -t 1 2
 ```
 
 ## Version History

diff --git a/SSLTest/SSLTest.py b/SSLTest/SSLTest.py
@@ -35,7 +35,7 @@ def get_tests_help():
 
 def get_help():
     return [
-        {"description": ["Script that scans a webservers cryptographic parameters and vulnerabilities"]},
+        {"description": ["Script that scans web servers cryptographic parameters and vulnerabilities "]},
         {"usage": [f"{SCRIPTNAME}.py <options>"]},
         {"usage_example": [f"{SCRIPTNAME}.py -u https://example.com -t 1 2"]},
         {"options": [

diff --git a/SSLTest/src/scan_parameters/non_ratable/WebServerSoft.py b/SSLTest/src/scan_parameters/non_ratable/WebServerSoft.py
@@ -52,7 +52,7 @@ def scan_software_http(self):
                 requests.exceptions.ConnectionError,
                 requests.exceptions.Timeout,
                 requests.exceptions.ReadTimeout):
-            value = 'unable to connect'
+            value = 'unable to connect (try scanning with nmap)'
         self.versions["http_header"] = value
 
     def scan_server_software(self):