mitre/heimdall_tools

Heimdall工具集

Heimdall Tools提供多种方法，将各类工具的输出转换为"Heimdall数据格式"(HDF)，以便在Heimdall中查看。该工具集包含多个转换器，支持多种安全扫描、合规审计工具的结果转换。

镜像概述和主要用途

Heimdall Tools是一个数据转换工具集，核心功能是将不同安全工具、合规工具的输出数据标准化为HDF格式，实现安全数据的统一管理和可视化。主要用途包括：安全扫描结果整合、合规审计数据标准化、多工具输出格式统一，以便在Heimdall平台中集中查看和分析。

核心功能和特性

支持的转换器

1. aws_config_mapper - 评估、审计和评估AWS资源
2. burpsuite_mapper - 商业动态分析工具
3. dbprotect_mapper - 数据库漏洞扫描器
4. fortify_mapper - 商业静态代码分析工具
5. jfrog_*_mapper** - 包漏洞扫描器
6. nessus_mapper - 商业安全扫描器（支持Tenable.sc和Tenable.io的合规性和漏洞扫描）
7. netsparker_mapper - Web应用安全扫描器
8. nikto_mapper - 开源Web服务器扫描器
9. sarif_mapper - 静态分析结果交换格式
10. scoutsuite_mapper - 多云安全审计工具
11. snyk_mapper - 商业包漏洞扫描器
12. sonarqube_mapper - 开源静态代码分析工具
13. xccdf_results_mapper - 可扩展配置检查列表描述结果格式
14. scc_mapper - SCAP合规检查器格式
15. zap_mapper - OWASP ZAP - 开源动态代码分析工具

使用场景和适用范围

适用于需要整合多种安全工具输出数据的场景，包括：

• 安全运营中心（SOC）的多源数据整合
• 合规审计团队的跨工具结果分析
• 开发团队的安全测试结果统一管理
• 企业安全态势可视化与报告生成

支持的工具类型涵盖静态代码分析、动态应用扫描、漏洞扫描、云资源审计、合规检查等多个安全领域。

使用方法和配置说明

前置要求

• Ruby 2.4或更高版本（使用ruby -v检查版本）

Linux系统Ruby安装

RHEL-based系统安装

使用RVM（Ruby版本管理器）安装Ruby：

bash
sudo yum install curl gpg gcc gcc-c++ make patch autoconf automake bison libffi-devel libtool patch readline-devel sqlite-devel zlib-devel openssl-devel
sudo gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
curl -sSL https://get.rvm.io | bash -s stable
source ~/.rvm/scripts/rvm
rvm install 2.6
rvm use 2.6 --default

验证安装版本：

bash
ruby -v
# 预期输出示例：ruby 2.6.5p114 (2019-10-01 revision 67812) [x86_64-linux]

Ubuntu-based系统安装

（原文未提供详细步骤，建议参考Ubuntu官方Ruby安装文档）

安装Heimdall Tools

bash
gem install heimdall_tools

命令行使用

在命令行中，heimdall_tools help会列出所有命令及简短描述。要获取特定命令的详细帮助，运行heimdall_tools help [COMMAND]，或在命令后添加-h, --help标志，如heimdall_tools fortify_mapper -h。

Docker使用

使用Docker时，将heimdall_tools命令替换为以下系统对应的Docker命令：

• Linux和Mac：

  bash
  docker run -it -v$(pwd):/share mitre/heimdall_tools
  

• Windows CMD：

  cmd
  docker run -it -v%cd%:/share mitre/heimdall_tools
  

注意：上述Docker命令会挂载当前目录到容器中。执行命令前，请确保已导航到包含待转换文件的目录。

各转换器详细使用说明

aws_config_mapper

拉取Ruby AWS SDK数据，将AWS Config规则结果转换为HDF格式JSON，以便在Heimdall中查看。

AWS Config规则映射：AWS Config规则到800-53控制的映射源自此链接。

AWS认证：Ruby AWS SDK认证配置开发者指南

USAGE: heimdall_tools aws_config_mapper [OPTIONS] -o

FLAGS:
    -o --output        : 输出扫描结果JSON的路径。
    -V --verbose       : 详细模式运行[可选]。

示例: heimdall_tools aws_config_mapper -o aws_config_results_hdf.json

burpsuite_mapper

将BurpSuite Pro导出的XML结果文件转换为HDF格式JSON，以便在Heimdall中查看。

USAGE: heimdall_tools burpsuite_mapper [OPTIONS] -x  -o

FLAGS:
    -x                : BurpSuitePro导出的XML结果文件路径。
    -o --output        : 输出扫描结果JSON的路径。
    -V --verbose       : 详细模式运行[可选]。

示例: heimdall_tools burpsuite_mapper -x burpsuite_results.xml -o scan_results.json

dbprotect_mapper

将DBProtect报告的"Check Results Details"格式XML转换为HDF格式JSON，以便在Heimdall中查看。

USAGE: heimdall_tools dbprotect_mapper [OPTIONS] -x  -o

FLAGS:
    -x            : DBProtect报告XML文件路径。
    -o --output   : 输出扫描结果JSON的路径。
    -V --verbose  : 详细模式运行[可选]。

示例: heimdall_tools dbprotect_mapper -x check_results_details_report.xml -o db_protect_hdf.json

fortify_mapper

将Fortify结果FVDL文件转换为HDF格式JSON，以便在Heimdall中查看。

USAGE: heimdall_tools fortify_mapper [OPTIONS] -f  -o

FLAGS:
    -f --fvdl     : Fortify扫描FVDL文件路径。
    -o --output   : 输出扫描结果JSON的路径。
    -V --verbose  : 详细模式运行[可选]。

示例: heimdall_tools fortify_mapper -f audit.fvdl -o scan_results.json

jfrog_***_mapper

将JFrog ***结果JSON文件转换为HDF格式JSON，以便在Heimdall中查看。

USAGE: heimdall_tools jfrog_xray_mapper [OPTIONS] -j  -o

FLAGS:
    -j            : Xray结果JSON文件路径。
    -o --output   : 输出扫描结果JSON的路径。
    -V --verbose  : 详细模式运行[可选]。

示例: heimdall_tools jfrog_xray_mapper -j xray_results.json -o xray_results_hdf.json

nessus_mapper

将Nessus导出的XML结果文件转换为HDF格式JSON，以便在Heimdall中查看。支持Tenable.sc和Tenable.io的合规性和漏洞扫描。

注意：会为Nessus报告中的每个主机生成单独的HDF JSON文件。

USAGE: heimdall_tools nessus_mapper [OPTIONS] -x  -o

FLAGS:
    -x           : Nessus导出的XML结果文件路径。
    -o --output_prefix : 输出扫描结果JSON的前缀路径。
    -V --verbose  : 详细模式运行[可选]。

示例: heimdall_tools nessus_mapper -x nessus-results.xml -o test-env

netsparker_mapper

将Netsparker XML结果文件转换为HDF格式JSON，以便在Heimdall中查看。当前版本仅支持Netsparker Enterprise漏洞扫描。

USAGE: heimdall_tools netsparker_mapper [OPTIONS] -x  -o

FLAGS:
    -x       : Netsparker结果XML文件路径。
    -o --output : 输出扫描结果JSON的路径。
    -V --verbose : 详细模式运行[可选]。

示例: heimdall_tools netsparker_mapper -x netsparker_results.xml -o netsparker_hdf.json

nikto_mapper

将Nikto结果JSON文件转换为HDF格式JSON，以便在Heimdall中查看。

注意：当前此映射器仅支持单目标Nikto扫描。

USAGE: heimdall_tools nikto_mapper [OPTIONS] -x  -o

FLAGS:
    -j           : Nikto结果JSON文件路径。
    -o --output_prefix : 输出扫描结果JSON的前缀路径。
    -V --verbose  : 详细模式运行[可选]。

示例: heimdall_tools nikto_mapper -j nikto_results.json -o nikto_results.json

sarif_mapper

将SARIF JSON文件转换为HDF格式JSON，以便在Heimdall中查看。

USAGE: heimdall_tools sarif_mapper [OPTIONS] -j  -o

FLAGS:
    -j           : SARIF结果JSON文件路径。
    -o --output_prefix : 输出扫描结果JSON的前缀路径。
    -V --verbose  : 详细模式运行[可选]。

示例: heimdall_tools sarif_mapper -j sarif_results.json -o sarif_results_hdf.json

scoutsuite_mapper

将Scout Suite结果从Javascript转换为HDF格式JSON，以便在Heimdall中查看。

注意：当前此映射器仅支持AWS。

USAGE: heimdall_tools scoutsuite_mapper -i  -o

FLAGS:
    -i --input -j --javascript  : Scout Suite结果Javascript文件路径。
    -o --output                 : 输出扫描结果JSON的路径。

示例: heimdall_tools scoutsuite_mapper -i scoutsuite_results.js -o scoutsuite_hdf.json

snyk_mapper

将Snyk结果JSON文件转换为HDF格式JSON，以便在Heimdall中查看。

注意：会为Snyk报告中的每个项目生成单独的HDF JSON文件。

USAGE: heimdall_tools snyk_mapper [OPTIONS] -x  -o

FLAGS:
    -j           : Snyk结果JSON文件路径。
    -o --output_prefix : 输出扫描结果JSON的前缀路径。
    -V --verbose  : 详细模式运行[可选]。

示例: heimdall_tools snyk_mapper -j snyk_results.json -o output-file-prefix

sonarqube_mapper

从API拉取指定项目的SonarQube结果，并输出为HDF格式JSON，以便在Heimdall中查看。

USAGE: heimdall_tools sonarqube_mapper [OPTIONS] -n  -u  -o

FLAGS:
    -n --name          : SonarQube中项目的项目键。
    -u --api_url       : SonarQube服务器API的URL，通常以/api结尾。
    --auth             : 用户名:密码或令牌[可选]。
    -o --output        : 输出扫描结果JSON的路径。
    -V --verbose       : 详细模式运行[可选]。

示例:
heimdall_tools sonarqube_mapper -n sonar_project_key -u http://sonar:9000/api -o scan_results.json
heimdall_tools sonarqube_mapper -n sonar_project_key -u http://sonar:9000/api --auth admin:admin -o scan_results.json

xccdf_results_mapper

注意：SCC输出的扫描结果为XCCDF-Results格式。

将XCCDF_Results XML扫描转换为HDF格式JSON，以便在Heimdall中查看。

USAGE: heimdall_tools xccdf_results_mapper [OPTIONS] -x  -o

FLAGS:
    -x            : XCCDF-Results XML文件路径。
    -o --output   : 输出扫描结果JSON的路径。

示例: heimdall_tools xccdf_results_mapper -x xccdf_results.xml -o scan_results.json

zap_mapper

将OWASP ZAP结果Json转换为HDF格式Json，以便在Heimdall中查看。

USAGE: heimdall_tools zap_mapper [OPTIONS] -j  -n  -o

FLAGS:
    -j --json    : OWASP ZAP结果JSON文件路径。
    -n --name    : 被评估站点的URL。
    -o --output  : 输出扫描结果JSON的路径。
    -V --verbose : 详细模式运行[可选]。

示例: heimdall_tools zap_mapper -j zap_results.json -n site_name -o scan_results.json

version

输出gem版本。

USAGE: heimdall_tools version