patrowl/engine-nessus

Nessus Engine (在线服务) 镜像文档

镜像概述

Nessus Engine是一个基于Python 3的在线服务引擎，用于与Nessus实例交互，执行安全扫描任务。该引擎支持扫描策略配置、扫描任务管理、报告生成等功能，需配合Nessus实例使用，适用于安全漏洞扫描自动化场景。

核心功能与特性

• 多类型扫描支持：支持未认证扫描和认证扫描（Windows、SSH等凭证类型）
• 报告生成：支持多种报告格式（默认格式、CSV等）
• 扫描管理：提供扫描列表查询、状态监控、任务停止等功能
• API接口：暴露HTTP接口用于触发扫描、获取报告及管理扫描任务
• 灵活配置：支持通过配置文件设置Nessus实例连接参数（主机、端口、认证信息）

使用场景

• 安全漏洞扫描自动化流程集成
• 定期安全评估任务执行
• 安全管理平台中的漏洞扫描模块
• 多场景扫描策略（内外网、不同凭证）的统一管理

使用方法与配置说明

依赖环境

• Python 3及pip包管理工具
• 可用的Nessus实例
• 其他Python依赖包（详见requirements.txt）

安装步骤

1. 安装Python依赖包

bash
# 进入引擎目录
cd PatrowlEngines/engines/nessus

# 创建并激活虚拟环境
virtualenv env --python=python3
source env/bin/activate

# 安装依赖包
pip3 install -r requirements.txt

2. 安装Nessus Python CLI并应用补丁

bash
# 创建外部库目录
mkdir -p external-libs && cd external-libs

# 克隆nessrest库
git clone https://github.com/tenable/nessrest

# 切换到指定版本
cd nessrest && git reset --hard af28834d6253db0d00e3ab46ab259dd5bc903063

# 应用补丁
git apply ../../etc/ness6rest.patch

# 安装库
pip3 install --trusted-host pypi.python.org -e $PWD/nessrest/

3. 上传扫描策略文件至Nessus实例

将etc/目录下的.nessus策略文件上传至Nessus实例。

4. 配置文件设置

创建配置文件nessus.json（可参考nessus.json.sample），配置以下参数：

• 基础认证配置：

  json
  {
    "server_host": "NESSUS_IP",
    "server_port": "8834",
    "server_username": "NESSUS_USERNAME",
    "server_password": "NESSUS_PASSWORD"
  }
  

• API密钥认证配置（替代基础认证）：

  json
  {
    "access_key": "xxxxxxxx",
    "secret_key": "yyyyyyyy"
  }
  

5. 启动引擎

bash
python engine-nessus.py [--port 5002] [--host 0.0.0.0] [--debug]

• --port：指定服务端口（默认5002）
• --host：指定绑定地址（默认0.0.0.0）
• --debug：启用调试模式

扫描策略示例

未认证扫描

json
{
  "action": "scan", 
  "policy": "DEFAULT.nessus"
}

认证扫描

json
{
  "action": "scan", 
  "policy": "DEFAULT.nessus", 
  "credentials": [
    {"type": "windows_password", "password": "mypass", "username": "nicolas"}, 
    {"type": "ssh_password", "password": "mypass", "username": "nicolas"}, 
    {"type": "ssh_password", "password": "mypass2", "username": "nicolas2"}
  ]
}

获取报告（不执行扫描）

json
{
  "name": "Scan Externe - IP Prod", 
  "action": "getreports"
}

API接口列表

• 获取扫描列表：http://0.0.0.0:5002/engines/nessus/_get_scanlist
• 获取扫描状态：http://0.0.0.0:5002/engines/nessus/_get_scan_status?scan_id=182
• 停止扫描：http://0.0.0.0:5002/engines/nessus/stopscan?scan_id=184
• 生成报告：http://0.0.0.0:5002/engines/nessus/genreport?scan_id=184
• 生成CSV格式报告：http://0.0.0.0:5002/engines/nessus/genreport?scan_id=184&format=csv
• 获取报告：http://0.0.0.0:5002/engines/nessus/getreport?scan_id=184&format=csv
• 获取扫描结果：http://0.0.0.0:5002/engines/nessus/getresults?scan_id=184