OpenVAS Legacy Executor¶
Category: Network and Vulnerability Scanners
Script: openvas_legacy.py
Integration: omp CLI
Faraday Plugin: OpenvasPlugin
Description¶
Uses the legacy omp (OpenVAS Management Protocol) command-line tool to create a scan target and task, execute the scan, wait for completion, and retrieve the XML report. This executor is intended for older OpenVAS installations that do not support the modern GVM API.
For modern GVM installations, use the GVM/OpenVAS executor instead.
Prerequisites¶
- OpenVAS installed with the
ompCLI tool available in$PATH - Valid OpenVAS credentials
Configuration¶
Environment Variables (Setup)¶
(none — credentials are passed as execution arguments)
Execution Arguments¶
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
OPENVAS_USER |
string | Yes | OpenVAS username |
OPENVAS_PASSW |
password | Yes | OpenVAS password |
OPENVAS_HOST |
ip | Yes | OpenVAS server IP address |
OPENVAS_PORT |
integer | Yes | OpenVAS port (typically 9390) |
OPENVAS_SCAN_URL |
url | Yes | Target host or IP to scan |
OPENVAS_SCAN_ID |
string | No | Scan configuration UUID (default: daba56c8-73ec-11df-a475-002264764cea — Full and Fast) |
YAML Configuration Example¶
executors:
openvas_legacy_scan:
repo_executor: openvas_legacy.py
max_size: 65536
varenvs: {}
params:
OPENVAS_USER:
mandatory: true
type: string
base: string
OPENVAS_PASSW:
mandatory: true
type: password
base: string
OPENVAS_HOST:
mandatory: true
type: ip
base: string
OPENVAS_PORT:
mandatory: true
type: integer
base: integer
OPENVAS_SCAN_URL:
mandatory: true
type: url
base: string
How It Works¶
- Runs
ompcommands to create a target definition - Creates a scan task referencing the target and scan configuration
- Starts the scan via
omp - Polls scan status until completion
- Retrieves the report in XML format
- Parses the XML through
OpenvasPluginand outputs Faraday JSON
Notes¶
- The
ompCLI is deprecated in modern Greenbone releases; migrate to the GVM executor when possible - All parameters (including credentials) are passed as execution arguments, not environment variables