heimdall_tools 1.3.49 → 1.3.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6386ac453df3c036d6fb57fd6993c338d3432c6c65dda92d06df94c808d4394
-  data.tar.gz: 1f215414fb5063abee81d84a760c1208a211dac9478dc8a96b95eb9f00d75b8f
+  metadata.gz: b18e944c199cc2c1312da5ea554db437f2c27853036334f95cdaad0567680788
+  data.tar.gz: 2404b491dbe900134e480fe3ae1f641206ed73b3e3d8f0c1225cec053a16b324
 SHA512:
-  metadata.gz: 6a1644af8db70b6de1853899547037c651886a1e8fed8d611826b8a367e5e26b60620bd2edc0d93735c4eb5da379a456f38d65be11bcc9b13e9977545f8566f5
-  data.tar.gz: 89b993467f7bf734dc5624218937090d3d093bbcdb979e80ecfe239b131a520abab7785a03204e4b707d613659ba82cee7e7894fdacef826599adebd440ce922
+  metadata.gz: d336f6df9950edf830d1d49ba13704b718ae3c1c9a3a9233813d64dba710499d27ccb0812b1eb0636f303201429b091026ec698d6e06e4e95f1efc41634e0c8d
+  data.tar.gz: ad4549d6ded0e20a3669634f8cb24836e6332966851921dbfb55e0a5d0811d6e98c9e155a461f1c1478335ddd92b6fbcb7c53de577a174a105f0f87a36f442d7

data/README.md

@@ -1,3 +1,7 @@
+# Heimdall Tools has been depreciated. See the new [SAF CLI](https://github.com/mitre/saf)
+
+
+
 # Heimdall Tools
 
 ![Overall Status](https://github.com/mitre/heimdall_tools/workflows/heimdall_tools/badge.svg)
@@ -5,17 +9,15 @@
 
 HeimdallTools supplies several methods to convert output from various tools to "Heimdall Data Format"(HDF) format to be viewable in Heimdall. The current converters are:
 
-1. [**asff_mapper**](#asff_mapper) - custom findings format for AWS Security Hub
-1. [**aws_config_mapper**](#aws_config_mapper) - assess, audit, and evaluate AWS resources
-1. [**burpsuite_mapper**](#burpsuite_mapper) - commercial dynamic analysis tool
-1. [**dbprotect_mapper**](#dbprotect_mapper) - database vulnerability scanner
-1. [**fortify_mapper**](#fortify_mapper) - commercial static code analysis tool
-1. [**jfrog_xray_mapper**](#jfrog_xray_mapper) - package vulnerability scanner
-1. [**nessus_mapper**](#nessus_mapper) - commercial security scanner (supports compliance and vulnerability scans from Tenable.sc and Tenable.io)
-1. [**netsparker_mapper**](#netsparker_mapper) - web application security scanner
-1. [**nikto_mapper**](#nikto_mapper) - open-source web server scanner
-1. [**prowler_mapper**](#prowler_mapper) - assess, audit, harden, and facilitate incidence response for AWS resources
-1. [**sarif_mapper**](#sarif_mapper) - static analysis results interchange format
+1.  [**aws_config_mapper**](#aws_config_mapper) - assess, audit, and evaluate AWS resources
+1.  [**burpsuite_mapper**](#burpsuite_mapper) - commercial dynamic analysis tool
+1.  [**dbprotect_mapper**](#dbprotect_mapper) - database vulnerability scanner
+1.  [**fortify_mapper**](#fortify_mapper) - commercial static code analysis tool
+1.  [**jfrog_xray_mapper**](#jfrog_xray_mapper) - package vulnerability scanner
+1.  [**nessus_mapper**](#nessus_mapper) - commercial security scanner (supports compliance and vulnerability scans from Tenable.sc and Tenable.io)
+1.  [**netsparker_mapper**](#netsparker_mapper) - web application security scanner
+1.  [**nikto_mapper**](#nikto_mapper) - open-source web server scanner
+1.  [**sarif_mapper**](#sarif_mapper) - static analysis results interchange format
 1. [**scoutsuite_mapper**](#scoutsuite_mapper) - multi-cloud security auditing tool
 1. [**snyk_mapper**](#snyk_mapper) - commercial package vulnerability scanner
 1. [**sonarqube_mapper**](#sonarqube_mapper) - open-source static code analysis tool
@@ -86,27 +88,6 @@ For Docker usage, replace the `heimdall_tools` command with the correct Docker c
 
 Note that all of the above Docker commands will mount your current directory on the Docker container. Ensure that you have navigated to the directory you intend to convert files in before executing the command.
 
-## asff_mapper
-
-asff_mapper translates AWS Security Finding Format results from JSON to HDF-formatted JSON so as to be viewable on Heimdall
-
-Note: The following commands are examples to extract data via the AWS CLI that need to be fed to the mapper:
-
-Output|Use|Command
----|---|---
-ASFF json|All the findings that will be fed into the mapper|aws securityhub get-findings > asff.json
-AWS SecurityHub enabled standards json|Get all the enabled standards so you can get their identifiers|aws securityhub get-enabled-standards > asff_standards.json
-AWS SecurityHub standard controls json|Get all the controls for a standard that will be fed into the mapper|aws securityhub describe-standards-controls --standards-subscription-arn "arn:aws:securityhub:us-east-1:123456789123:subscription/cis-aws-foundations-benchmark/v/1.2.0" > asff_cis_standard.json
-
-    USAGE: heimdall_tools asff_mapper -i <asff-finding-json> [--sh <standard-1-json> ... <standard-n-json>] -o <hdf-scan-results-json>
-
-    FLAGS:
-        -i --input -j --json <asff-finding-json>                   : path to ASFF findings file.
-        --sh --securityhub-standards --input-securityhub-standards : array of paths to AWS SecurityHub standard files.
-        -o --output <hdf-scan-results-json>                        : path to output scan-results json.
-
-    example: heimdall_tools asff_mapper -i asff_findings.json --sh aws_standard.json cis_standard.json -o asff_hdf.json
-
 ## aws_config_mapper
 
 aws_config_mapper pulls Ruby AWS SDK data to translate AWS Config Rule results into HDF format json to be viewable in Heimdall
@@ -120,11 +101,11 @@ aws_config_mapper pulls Ruby AWS SDK data to translate AWS Config Rule results i
   [Developer Guide for configuring Ruby AWS SDK for authentication](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html)
 
     USAGE: heimdall_tools aws_config_mapper [OPTIONS] -o
-
+    
     FLAGS:
-        -o --output  : path to output scan-results json.
-        -V --verbose : verbose run [optional].
-
+        -o --output        : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools aws_config_mapper -o aws_config_results_hdf.json
 
 ## burpsuite_mapper
@@ -132,12 +113,12 @@ aws_config_mapper pulls Ruby AWS SDK data to translate AWS Config Rule results i
 burpsuite_mapper translates an BurpSuite Pro exported XML results file into HDF format json to be viewable in Heimdall
 
     USAGE: heimdall_tools burpsuite_mapper [OPTIONS] -x  -o
-
+    
     FLAGS:
-        -x           : path to BurpSuitePro exported XML results file.
-        -o --output  : path to output scan-results json.
-        -V --verbose : verbose run [optional].
-
+        -x                : path to BurpSuitePro exported XML results file.
+        -o --output        : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools burpsuite_mapper -x burpsuite_results.xml -o scan_results.json
 
 ## dbprotect_mapper
@@ -145,12 +126,12 @@ burpsuite_mapper translates an BurpSuite Pro exported XML results file into HDF
 dbprotect_mapper translates DBProtect report in `Check Results Details` format XML to HDF format JSON be viewed on Heimdall.
 
     USAGE: heimdall_tools dbprotect_mapper [OPTIONS] -x  -o
-
+    
     FLAGS:
-        -x           : path to DBProtect report XML file.
-        -o --output  : path to output scan-results json.
-        -V --verbose : verbose run [optional].
-
+        -x            : path to DBProtect report XML file.
+        -o --output        : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools dbprotect_mapper -x check_results_details_report.xml -o db_protect_hdf.json
 
 ## fortify_mapper
@@ -158,12 +139,12 @@ dbprotect_mapper translates DBProtect report in `Check Results Details` format X
 fortify_mapper translates an Fortify results FVDL file into HDF format json to be viewable in Heimdall
 
     USAGE: heimdall_tools fortify_mapper [OPTIONS] -f  -o
-
+    
     FLAGS:
-    	-f --fvdl    : path to Fortify Scan FVDL file.
-    	-o --output  : path to output scan-results json.
-    	-V --verbose : verbose run [optional].
-
+    	-f --fvdl          : path to Fortify Scan FVDL file.
+    	-o --output        : path to output scan-results json.
+    	-V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools fortify_mapper -f audit.fvdl -o scan_results.json
 
 ## jfrog_xray_mapper
@@ -171,12 +152,12 @@ fortify_mapper translates an Fortify results FVDL file into HDF format json to b
 jfrog_xray_mapper translates an JFrog Xray results JSON file into HDF format JSON to be viewable in Heimdall
 
     USAGE: heimdall_tools jfrog_xray_mapper [OPTIONS] -j  -o
-
+    
     FLAGS:
-        -j           : path to xray results JSON file.
-        -o --output  : path to output scan-results json.
-        -V --verbose : verbose run [optional].
-
+        -j            : path to xray results JSON file.
+        -o --output        : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools jfrog_xray_mapper -j xray_results.json -o xray_results_hdf.json
 
 ## nessus_mapper
@@ -187,12 +168,12 @@ Supports compliance and vulnerability scans from Tenable.sc and Tenable.io.
 Note: A separate HDF JSON file is generated for each host reported in the Nessus Report.
 
     USAGE: heimdall_tools nessus_mapper [OPTIONS] -x  -o
-
+    
     FLAGS:
-        -x                 : path to Nessus-exported XML results file.
-        -o --output_prefix : path to output scan-results json.
-        -V --verbose       : verbose run [optional].
-
+        -x           : path to Nessus-exported XML results file.
+        -o --output_prefix       : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools nessus_mapper -x nessus-results.xml -o test-env
 
 ## netsparker_mapper
@@ -202,12 +183,12 @@ netsparker_mapper translates an Netsparker XML results file into HDF format JSON
 The current iteration only works with Netsparker Enterprise Vulnerabilities Scan.
 
     USAGE: heimdall_tools netsparker_mapper [OPTIONS] -x  -o
-
+    
     FLAGS:
-        -x           : path to netsparker results XML file.
-        -o --output  : path to output scan-results json.
-        -V --verbose : verbose run [optional].
-
+        -x       : path to netsparker results XML file.
+        -o --output        : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools netsparker_mapper -x netsparker_results.xml -o netsparker_hdf.json
 
 ## nikto_mapper
@@ -217,39 +198,25 @@ nikto_mapper translates an Nikto results JSON file into HDF format JSON to be vi
 Note: Current this mapper only support single target Nikto Scans.
 
     USAGE: heimdall_tools nikto_mapper [OPTIONS] -x  -o
-
+    
     FLAGS:
-        -j                 : path to Nikto results JSON file.
-        -o --output_prefix : path to output scan-results json.
-        -V --verbose       : verbose run [optional].
-
+        -j           : path to Nikto results JSON file.
+        -o --output_prefix       : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools nikto_mapper -j nikto_results.json -o nikto_results.json
 
-## prowler_mapper
-
-prowler_mapper translates Prowler-derived AWS Security Finding Format results from concatenated JSON blobs to HDF-formatted JSON so as to be viewable on Heimdall
-
-Note: Currently this mapper only supports Prowler's ASFF output format.
-
-    USAGE: heimdall_tools prowler_mapper -i <prowler-asff-json> -o <hdf-scan-results-json>
-
-    FLAGS:
-        -i --input -j --json <prowler-asff-json> : path to Prowler ASFF findings file.
-        -o --output <hdf-scan-results-json>      : path to output scan-results json.
-
-    example: heimdall_tools prowler_mapper -i prowler_results.js -o prowler_hdf.json
-
 ## sarif_mapper
 
 sarif_mapper translates a SARIF JSON file into HDF format JSON to be viewable in Heimdall
 
     USAGE: heimdall_tools sarif_mapper [OPTIONS] -j  -o
-
+    
     FLAGS:
-        -j                 : path to SARIF results JSON file.
-        -o --output_prefix : path to output scan-results json.
-        -V --verbose       : verbose run [optional].
-
+        -j           : path to SARIF results JSON file.
+        -o --output_prefix       : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools sarif_mapper -j sarif_results.json -o sarif_results_hdf.json
 
 ## scoutsuite_mapper
@@ -259,11 +226,11 @@ scoutsuite_mapper translates Scout Suite results from Javascript to HDF-formatte
 Note: Currently this mapper only supports AWS.
 
     USAGE: heimdall_tools scoutsuite_mapper -i  -o
-
+    
     FLAGS:
-        -i --input -j --javascript : path to Scout Suite results Javascript file.
-        -o --output                : path to output scan-results json.
-
+        -i --input -j --javascript  : path to Scout Suite results Javascript file.
+        -o --output                 : path to output scan-results json.
+    
     example: heimdall_tools scoutsuite_mapper -i scoutsuite_results.js -o scoutsuite_hdf.json
 
 ## snyk_mapper
@@ -273,12 +240,12 @@ snyk_mapper translates an Snyk results JSON file into HDF format json to be view
 Note: A separate HDF JSON is generated for each project reported in the Snyk Report.
 
     USAGE: heimdall_tools snyk_mapper [OPTIONS] -x  -o
-
+    
     FLAGS:
-        -j                 : path to Snyk results JSON file.
-        -o --output_prefix : path to output scan-results json.
-        -V --verbose       : verbose run [optional].
-
+        -j           : path to Snyk results JSON file.
+        -o --output_prefix       : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools snyk_mapper -j snyk_results.json -o output-file-prefix
 
 ## sonarqube_mapper
@@ -286,18 +253,18 @@ Note: A separate HDF JSON is generated for each project reported in the Snyk Rep
 sonarqube_mapper pulls SonarQube results, for the specified project, from the API and outputs in HDF format Json to be viewed on Heimdall
 
     USAGE: heimdall_tools sonarqube_mapper [OPTIONS] -n  -u  -o
-
+    
     FLAGS:
-        -n --name    : Project Key of the project in SonarQube
-        -u --api_url : url of the SonarQube Server API. Typically ends with /api.
-        --auth       : username:password or token [optional].
-        -o --output  : path to output scan-results json.
-        -V --verbose : verbose run [optional].
-
+        -n --name          : Project Key of the project in SonarQube
+        -u --api_url            : url of the SonarQube Server API. Typically ends with /api.
+        --auth               : username:password or token [optional].
+        -o --output        : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example:
-
+    
     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
@@ -307,11 +274,11 @@ Note: SCC outputs scan results in XCCDF-Results format.
 xccdf_results_mapper translates an XCCDF_Results XML scan into HDF format json to be viewable in Heimdall.
 
     USAGE: heimdall_tools xccdf_results_mapper [OPTIONS] -x  -o
-
+    
     FLAGS:
-        -x          : path to XCCDF-Results XML file.
-        -o --output : path to output scan-results json.
-
+        -x            : path to XCCDF-Results XML file.
+        -o --output        : path to output scan-results json.
+    
     example: heimdall_tools xccdf_results_mapper -x xccdf_results.xml -o scan_results.json
 
 ## zap_mapper
@@ -319,13 +286,13 @@ xccdf_results_mapper translates an XCCDF_Results XML scan into HDF format json t
 zap_mapper translates OWASP ZAP results Json to HDF format Json be viewed on Heimdall
 
     USAGE: heimdall_tools zap_mapper [OPTIONS] -j  -n  -o
-
+    
     FLAGS:
-        -j --json    : path to OWASP ZAP results JSON file.
-        -n --name    : URL of the site being evaluated.
-        -o --output  : path to output scan-results json.
-        -V --verbose : verbose run [optional].
-
+        -j --json              : path to OWASP ZAP results JSON file.
+        -n --name             : URL of the site being evaluated.
+        -o --output        : path to output scan-results json.
+        -V --verbose                     : verbose run [optional].
+    
     example: heimdall_tools zap_mapper -j zap_results.json -n site_name -o scan_results.json
 
 ## version
@@ -392,7 +359,6 @@ To release a new version, update the version number in `version.rb` according to
 
 ### Authors
 
--   Author:: Amndeep Singh Mann [Amndeep7](https://github.com/Amndeep7)
 -   Author:: Rony Xavier [rx294](https://github.com/rx294)
 -   Author:: Dan Mirsky [mirskiy](https://github.com/mirskiy)
 

data/lib/heimdall_tools.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.expand_path(__dir__))
 require 'heimdall_tools/version'
+puts "NOTICE: The heimdall_tools Ruby gem is deprecated. Please see instructions on how to convert to the new TypeScript SAF CLI. https://github.com/mitre/saf\n\n"
 
 module HeimdallTools
   autoload :Help, 'heimdall_tools/help'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heimdall_tools
 version: !ruby/object:Gem::Version
-  version: 1.3.49
+  version: 1.3.50
 platform: ruby
 authors:
 - Robert Thew
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-configservice
@@ -304,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Convert a variety of security product results to HDF