heimdall_tools 1.3.32 → 1.3.33

data/lib/heimdall_tools.rb

@@ -11,4 +11,5 @@ module HeimdallTools
   autoload :BurpSuiteMapper, 'heimdall_tools/burpsuite_mapper'
   autoload :NessusMapper, 'heimdall_tools/nessus_mapper'
   autoload :SnykMapper, 'heimdall_tools/snyk_mapper'
+  autoload :NiktoMapper, 'heimdall_tools/nikto_mapper'
 end

data/lib/heimdall_tools/cli.rb

@@ -61,8 +61,8 @@ module HeimdallTools
       
     end
 
-    desc 'snyk_mapper', 'snyk_mapper translates Synk results Json to HDF format Json be viewed on Heimdall'
-    long_desc Help.text(:fortify_mapper)
+    desc 'snyk_mapper', 'snyk_mapper translates Snyk results Json to HDF format Json be viewed on Heimdall'
+    long_desc Help.text(:snyk_mapper)
     option :json, required: true, aliases: '-j'
     option :output_prefix, required: true, aliases: '-o'
     option :verbose, type: :boolean, aliases: '-V'
@@ -75,6 +75,18 @@ module HeimdallTools
       end
     end
 
+    desc 'nikto_mapper', 'nikto_mapper translates Nikto results Json to HDF format Json be viewed on Heimdall'
+    long_desc Help.text(:nikto_mapper)
+    option :json, required: true, aliases: '-j'
+    option :output, required: true, aliases: '-o'
+    option :verbose, type: :boolean, aliases: '-V'
+    def nikto_mapper
+      hdf = HeimdallTools::NiktoMapper.new(File.read(options[:json])).to_hdf
+      File.write(options[:output], hdf)
+      puts "\r\HDF Generated:\n"
+      puts "#{options[:output]}"
+    end
+
     desc 'version', 'prints version'
     def version
       puts VERSION

data/lib/heimdall_tools/help/nikto_mapper.md

@@ -0,0 +1,7 @@
+  nikto_mapper translates an Nikto results JSON file into HDF format JSON to be viewable in Heimdall
+  
+  Note: Current this mapper only support single target Nikto Scans.
+
+Examples:
+
+  heimdall_tools nikto_mapper [OPTIONS] -x <nikto-results-json> -o <hdf-scan-results.json>

data/lib/heimdall_tools/nikto_mapper.rb

@@ -0,0 +1,152 @@
+require 'json'
+require 'csv'
+require 'heimdall_tools/hdf'
+
+RESOURCE_DIR = Pathname.new(__FILE__).join('../../data')
+
+NIKTO_NIST_MAPPING_FILE = File.join(RESOURCE_DIR, 'nikto-nist-mapping.csv')
+
+IMPACT_MAPPING = {
+  high: 0.7,
+  medium: 0.5,
+  low: 0.3,
+}.freeze
+
+DEFAULT_NIST_TAG = ["SA-11", "RA-5"].freeze
+
+# Loading spinner sign
+$spinner = Enumerator.new do |e|
+  loop do
+    e.yield '|'
+    e.yield '/'
+    e.yield '-'
+    e.yield '\\'
+  end
+end
+
+module HeimdallTools
+  class NiktoMapper
+    def initialize(nikto_json, name=nil, verbose = false)
+      @nikto_json = nikto_json
+      @verbose = verbose
+
+      begin
+        @nikto_nist_mapping = parse_mapper
+      rescue StandardError => e
+        raise "Invalid Nikto to NIST mapping file: Exception: #{e}"
+      end
+
+        # TODO: Support Multi-target scan results
+        # Nikto multi-target scans generate invalid format JSONs
+        # Possible workaround to use https://stackoverflow.com/a/58209963/1670307
+
+      begin
+        @project = JSON.parse(nikto_json)
+      rescue StandardError => e
+        raise "Invalid Nikto JSON file provided Exception: #{e}"
+      end
+    end
+
+    def extract_scaninfo(project)
+      info = {}
+      begin
+        info['policy'] = 'Nikto Website Scanner'
+        info['version'] = NA_STRING
+        info['projectName'] = "Host: #{project['host']} Port: #{project['port']}"
+        info['summary'] = "Banner: #{project['banner']}"
+
+        info
+      rescue StandardError => e
+        raise "Error extracting project info from nikto JSON file provided Exception: #{e}"
+      end
+    end
+
+    def finding(vulnerability)
+      finding = {}
+      finding['status'] = 'failed'
+      finding['code_desc'] = "URL : #{vulnerability['url'].to_s } Method: #{vulnerability['method'].to_s}"
+      finding['run_time'] = NA_FLOAT
+
+      # Nikto results JSON does not profile scan timestamp; using current time to satisfy HDF format
+      finding['start_time'] = NA_STRING
+      [finding]
+    end
+
+    def nist_tag(niktoid)
+      entries = @nikto_nist_mapping.select { |x| niktoid.eql?(x[:niktoid].to_s) }
+      tags = entries.map { |x| x[:nistid] }
+      tags.empty? ? DEFAULT_NIST_TAG : tags.flatten.uniq
+    end
+
+    def impact(severity)
+      IMPACT_MAPPING[severity.to_sym]
+    end
+
+    def parse_mapper
+      csv_data = CSV.read(NIKTO_NIST_MAPPING_FILE, **{ encoding: 'UTF-8',
+                                                   headers: true,
+                                                   header_converters: :symbol})
+      csv_data.map(&:to_hash)
+    end
+
+    def desc_tags(data, label)
+      { "data": data || NA_STRING, "label": label || NA_STRING }
+    end
+
+    # Nikto report could have multiple vulnerability entries for multiple findings of same issue type.
+    # The meta data is identical across entries 
+    # method collapse_duplicates return unique controls with applicable findings collapsed into it.
+    def collapse_duplicates(controls)
+      unique_controls = []
+
+      controls.map { |x| x['id'] }.uniq.each do |id|
+        collapsed_results = controls.select { |x| x['id'].eql?(id) }.map {|x| x['results']}
+        unique_control = controls.find { |x| x['id'].eql?(id) }
+        unique_control['results'] = collapsed_results.flatten
+        unique_controls << unique_control
+      end
+      unique_controls
+    end
+
+
+    def to_hdf
+      controls = []
+      @project['vulnerabilities'].each do | vulnerability |
+        printf("\rProcessing: %s", $spinner.next)
+
+        item = {}
+        item['tags']               = {}
+        item['descriptions']       = []
+        item['refs']               = NA_ARRAY
+        item['source_location']    = NA_HASH
+        item['descriptions']       = NA_ARRAY
+
+        item['title']              = vulnerability['msg'].to_s
+        item['id']                 = vulnerability['id'].to_s
+
+        # Nikto results JSON does not description fields
+        # Duplicating vulnerability msg field
+        item['desc']               = vulnerability['msg'].to_s
+
+        # Nitko does not provide finding severity; hard-coding severity to medium 
+        item['impact']             = impact('medium') 
+        item['code']               = NA_STRING
+        item['results']            = finding(vulnerability)
+        item['tags']['nist']       = nist_tag( vulnerability['id'].to_s )
+        item['tags']['ösvdb']      = vulnerability['OSVDB']
+
+        controls << item
+      end
+
+      controls = collapse_duplicates(controls)
+      scaninfo = extract_scaninfo(@project)
+      results = HeimdallDataFormat.new(profile_name: scaninfo['policy'],
+                                       version: scaninfo['version'],
+                                       title: "Nikto Target: #{scaninfo['projectName']}",
+                                       summary: "Banner: #{scaninfo['summary']}",
+                                       controls: controls,
+                                       target_id: scaninfo['projectName'])
+      results.to_hdf
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heimdall_tools
 version: !ruby/object:Gem::Version
-  version: 1.3.32
+  version: 1.3.33
 platform: ruby
 authors:
 - Robert Thew
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -211,6 +211,7 @@ files:
 - lib/data/U_CCI_List.xml
 - lib/data/cwe-nist-mapping.csv
 - lib/data/nessus-plugins-nist-mapping.csv
+- lib/data/nikto-nist-mapping.csv
 - lib/data/owasp-nist-mapping.csv
 - lib/heimdall_tools.rb
 - lib/heimdall_tools/burpsuite_mapper.rb
@@ -222,10 +223,12 @@ files:
 - lib/heimdall_tools/help/burpsuite_mapper.md
 - lib/heimdall_tools/help/fortify_mapper.md
 - lib/heimdall_tools/help/nessus_mapper.md
+- lib/heimdall_tools/help/nikto_mapper.md
 - lib/heimdall_tools/help/snyk_mapper.md
 - lib/heimdall_tools/help/sonarqube_mapper.md
 - lib/heimdall_tools/help/zap_mapper.md
 - lib/heimdall_tools/nessus_mapper.rb
+- lib/heimdall_tools/nikto_mapper.rb
 - lib/heimdall_tools/snyk_mapper.rb
 - lib/heimdall_tools/sonarqube_mapper.rb
 - lib/heimdall_tools/version.rb