How gigachad80/vulturescan works
Project Type and Core Purpose
• Vulturescan is essentially an upgraded vulnerability scanning module (a derivative of Vulscan) that integrates with Nmap.
• Its main function is to match discovered versions (via Nmap) with entries from various vulnerability databases (CSV files) to highlight vulnerabilities in the target system.
File Structure
• Top-Level Components:
• Vulnerability Databases: Multiple CSV files (e.g., cve.csv, exploitdb.csv, openvas.csv, osvdb.csv, scipvuldb.csv, securityfocus.csv, securitytracker.csv, xforce.csv) represent different vulnerability sources.
• Update Mechanism: update.sh (and update.ps1) are provided to automate fetching the latest exploits and vulnerabilities into the CSVs.
• Scanning Module: The main script, vulturescan.nse, is the Nmap NSE module that ties these components into a single vulnerability scan when invoked via Nmap.
• Ancillary Files: LICENSE and README.md provide project documentation and legal information.
• Architectural Pattern:
System Components and Their Interactions
• Nmap Integration (vulturescan.nse):
• Acts as the entry point when a vulnerability scan is executed.
• Uses Nmap’s version detection to determine which software versions are present on the target.
• Vulnerability Databases (CSV files):
• Provide the raw vulnerability data (IDs, titles, perhaps links to more details).
• The scanning module loads and cross-references this data against identified service versions.
• Update Scripts (update.sh / update.ps1):
• Periodically fetch the latest vulnerability data from external sources (e.g., ExploitDB, CVE databases) and update the CSV files.
• Data Flow:
• When a scan command is executed (like “nmap -sV --script=vulturescan/vulturescan.nse www.example.com”), Nmap calls the NSE script.
• The script then reads the local CSV vulnerability databases.
• It processes the scan results (including version details) and relates them with the vulnerability information from the databases.
• The output is then formatted as per the user's provided template or default structure.
Important Architectural Patterns and Design Principles
• Modularity: Separation between data (databases and update mechanisms) and processing (NSE script).
• Update and Maintenance: The update scripts support a plug-and-play routine to maintain up-to-date data.
• Extensibility: Users can supply their own custom databases (single database mode) and report output formats.
• Integration with Nmap: Leveraging an existing scanning tool, it focuses on supplementing the vulnerability detection process with updated data.
Relevant Technologies, Frameworks, and Dependencies
• Lua Language: Used to write the Nmap script (vulturescan.nse).
• Nmap Framework: The primary scanning tool that executes the script.
• Shell Scripting (Bash/PowerShell): Provided update scripts to refresh vulnerability databases.