Final Changes

Author: vs4vijay

.env.example

@@ -1,4 +1,3 @@
-
 # Application Configuration
 
 DUPLICATE_MATCH_PERCENTAGE_THRESHOLD=20
@@ -20,4 +19,4 @@ NEXPOSE_PASSWORD=''
 
 OPENVAS_SOCKET='/var/run/openvasmd.sock'
 OPENVAS_USERNAME=
-OPENVAS_PASSWORD=
+OPENVAS_PASSWORD=

README.md

@@ -1,9 +1,41 @@
-# VulnScanner
+# MultiScanner
 
-Security Tool which scans a target using OpenVAS, Zap, and Nexpose. And consolidates the scan result.
+A Security Tool which scans a target using OpenVAS, Zap, and Nexpose. And consolidates the scan results.
+
+---
+
+## Usage
+
+### Start a scan against a Target
+
+`./main.py --scan-name <scan-name> --target <url>`
 
 
-![](/screenshots/screenshot1.png)
+### Get scan result
+
+`./main.py --scan-name <scan-name>`
+
+
+### Pause/Resume a scan result
+
+- `./main.py --scan-name <scan-name> --pause`
+- `./main.py --scan-name <scan-name> --resume`
+
+---
+
+## Screenshots
+
+Scanner Options:
+
+![Scanner Options](/screenshots/screenshot_0.png)
+
+Scanner Report:
+
+![Scanner Report](/screenshots/screenshot_1.png)
+
+Final Output:
+
+![Final Output](/screenshots/screenshot_2.png)
 
 ---
 
@@ -24,55 +56,40 @@ OR
 
 Run in Virtual Env:
 
-```
+```console
 python3 -m venv .venv
 
 source .venv/bin/activate
 
 pip3 install -r requirements.txt
 ```
----
 
+---
 
 ## Configuration
 
 The configuration of scanners will be in Environment File `.env`. There is sample `.env.example` file in the codebase, update the values with the proper API Keys and Credentials details before using. Rename it to `.env`.
 
 ---
 
-
-## Start a scan against a Target
-
-`./main.py --scan-name <scan-name> --target <url>`
-
-
-## Get scan result
-
-`./main.py --scan-name <scan-name>`
-
-
-## Pause/Resume a scan result
-
-- `./main.py --scan-name <scan-name> --pause`
-- `./main.py --scan-name <scan-name> --resume`
-
-
 ## Targets to Test
 - http://scanme.nmap.org
 - http://webscantest.com
 
 ---
 
-
 ## ToDo
+- [ ] Dockerize
 - [ ] Add Nessus
 - [ ] Error Stack
 - [ ] auto reload
 - [ ] Remove logs
 - [ ] Save to CSV
 - [ ] Make it interactive
 - [ ] OOPs
+- [ ] Improve Scan Results and Output
 - [ ] Color logging
+
 ---
 
 ### Scanner Interface:

core/common_service.py

@@ -14,7 +14,7 @@
 
 load_dotenv(find_dotenv())
 
-logging.basicConfig(filename='vuln-scanner.log', level=logging.INFO)
+logging.basicConfig(filename='scanner.log', level=logging.INFO)
 
 def main(config):
 
@@ -56,7 +56,7 @@ def main(config):
     parser.add_argument('-t', '--target', help='Specify the Target URL or IP')
     parser.add_argument('-p', '--pause', action='store_true', help='Pause a specified scan')
     parser.add_argument('-r', '--resume', action='store_true', help='Resume a specified scan')
-    parser.add_argument('-v', '--version', action='version', version='VulnScanner 1.0')
+    parser.add_argument('-v', '--version', action='version', version='MultiScanner 1.0')
     args = parser.parse_args()
 
     config = {

main.py

@@ -10,7 +10,6 @@
 
 from .scanner import Scanner
 from core.storage_service import StorageService
-from core.common_service import CommonService
 
 load_dotenv(find_dotenv())
 
@@ -25,7 +24,7 @@ class NexposeScanner(Scanner):
     name = 'Nexpose'
 
     def __init__(self):
-        self.nexpose_config = rapid7vmconsole.Configuration(name='VulnScanner')
+        self.nexpose_config = rapid7vmconsole.Configuration(name='Scanner')
         self.nexpose_config.username = config['USERNAME']
         self.nexpose_config.password = config['PASSWORD']
         self.nexpose_config.host = config['HOST']
@@ -50,7 +49,6 @@ def __init__(self):
         self.nexpose_assets = rapid7vmconsole.AssetApi(api_client)
         self.nexpose_report = rapid7vmconsole.ReportApi(api_client)
         self.storage_service = StorageService()
-        self.common_service = CommonService()
 
 
     def start(self, scan_name, target):

scanners/nexpose_scanner.py

@@ -13,7 +13,6 @@
 
 from .scanner import Scanner
 from core.storage_service import StorageService
-from core.common_service import CommonService
 
 load_dotenv(find_dotenv())
 
@@ -35,7 +34,6 @@ def __init__(self):
         transform = EtreeTransform()
         self.gmp = Gmp(connection, transform=transform)
         self.storage_service = StorageService()
-        self.common_service = CommonService()
 
         # Login
         try:

scanners/openvas_scanner.py

@@ -9,7 +9,6 @@
 
 from .scanner import Scanner
 from core.storage_service import StorageService
-from core.common_service import CommonService
 
 load_dotenv(find_dotenv())
 
@@ -29,7 +28,6 @@ class ZapScanner(Scanner):
     def __init__(self):
         self.zap = ZAPv2(apikey=API_KEY)
         self.storage_service = StorageService()
-        self.common_service = CommonService()
 
     def start(self, scan_name, target):
         print(f'[{self.name}] Starting Scan for Target: {target}')