patrowl/engine-openvas

OpenVAS REST API引擎

镜像概述

OpenVAS REST API引擎是一个提供RESTful API接口的服务，用于与OpenVAS漏洞扫描系统交互。通过该引擎，用户可以通过API调用实现扫描任务的启动、状态查询、结果获取等操作，适用于集成到安全扫描平台、自动化安全测试流程或安全监控系统中。

核心功能

• 提供REST API接口，支持与OpenVAS系统进行交互
• 支持扫描任务启动、状态查询及扫描结果获取
• 可与Patrowl Manager等安全管理平台集成
• 支持自定义扫描选项配置（如是否创建目标、任务及启动任务）

依赖项

• Python 3及pip包管理工具
• 其他Python依赖包（详见requirements.txt，通过pip install -r requirements.txt安装）
• Python-gvm库（安装方法如下）：

  bash
  mkdir -p libs && cd libs && git clone git://github.com/greenbone/python-gvm && pip3 install -e python-gvm
  

• OpenVAS实例（推荐20.08版本，安装指南：[***]
• 在OpenVAS中创建新任务，并在openvas.json中配置task_id

使用场景

• 安全扫描平台集成：作为中间件为上层平台提供OpenVAS扫描能力
• 自动化安全测试：与CI/CD流程集成，实现代码提交后的自动漏洞扫描
• 安全监控系统：定期执行扫描任务并获取结果，用于安全状态监控
• 批量扫描管理：通过API批量控制多个扫描任务的执行与结果收集

使用方法

配置步骤

1. 确保OpenVAS 20.08实例已正确部署并运行
2. 在OpenVAS中创建扫描任务，记录任务ID
3. 在openvas.json配置文件中设置task_id
4. 安装所需依赖包（详见依赖项部分）

API测试示例

环境变量设置

bash
OPENVAS_ENGINE_URL=http://patrowl-900.domain.net:5016/engines/openvas
ASSET_FQDN=patrowl.io

引擎状态查询

bash
curl "${OPENVAS_ENGINE_URL}"/info

启动扫描

bash
curl "${OPENVAS_ENGINE_URL}"/startscan -XPOST -H 'Accept: application/json' -H 'Content-type: application/json' -d "{\"scan_id\": 1, \"options\": {\"enable_create_task\": \"False\", \"enable_create_target\": \"False\", \"enable_start_task\": \"False\"}, \"assets\": [{\"datatype\": \"domain\", \"criticity\": \"medium\", \"id\": 1, \"value\": \"$ASSET_FQDN\"}], \"engine_id\": 9}"

扫描状态查询

bash
curl "${OPENVAS_ENGINE_URL}"/status/1

获取扫描结果（仅可获取一次，获取后报告将被删除）

bash
curl "${OPENVAS_ENGINE_URL}"/getfindings/1

Patrowl Manager集成配置

仅获取模式

Engine: OPENVAS

Options: {"enable_create_target": "False", "enable_start_task": "False", "enable_create_task": "False"}

Scopes: System infrastructure

创建并运行模式

Engine: OPENVAS

Options: {"enable_create_target": "True", "enable_start_task": "True", "enable_create_task": "True"}

Scopes: System infrastructure

配置参数说明