inspec_tools 2.0.6 → 2.3.2

data/lib/inspec_tools/inspec.rb

@@ -9,17 +9,14 @@ require_relative '../happy_mapper_tools/stig_checklist'
 require_relative '../happy_mapper_tools/benchmark'
 require_relative '../utilities/inspec_util'
 require_relative 'csv'
-
-# rubocop:disable Metrics/ClassLength
-# rubocop:disable Metrics/AbcSize
-# rubocop:disable Metrics/BlockLength
-# rubocop:disable Style/GuardClause
+require_relative '../utilities/xccdf/from_inspec'
+require_relative '../utilities/xccdf/to_xccdf'
 
 module InspecTools
-  class Inspec
-    def initialize(inspec_json, metadata = '{}')
+  class Inspec # rubocop:disable Metrics/ClassLength
+    def initialize(inspec_json, metadata = {})
       @json = JSON.parse(inspec_json.gsub(/\\+u0000/, ''))
-      @metadata = JSON.parse(metadata)
+      @metadata = metadata
     end
 
     def to_ckl(title = nil, date = nil, cklist = nil)
@@ -36,16 +33,15 @@ module InspecTools
       @checklist.to_xml.encode('UTF-8').gsub('<?xml version="1.0"?>', '<?xml version="1.0" encoding="UTF-8"?>').chomp
     end
 
+    # Convert Inspec result data to XCCDF
+    #
+    # @param attributes [Hash] Optional input attributes
+    # @return [String] XML formatted String
     def to_xccdf(attributes, verbose = false)
-      @data = Utils::InspecUtil.parse_data_for_xccdf(@json)
-      @attribute = attributes
-      @attribute = {} if @attribute.eql? false
+      data = Utils::FromInspec.new.parse_data_for_xccdf(@json)
       @verbose = verbose
-      @benchmark = HappyMapperTools::Benchmark::Benchmark.new
-      populate_header
-      # populate_profiles @todo populate profiles; not implemented now because its use is deprecated
-      populate_groups
-      @benchmark.to_xml
+
+      Utils::ToXCCDF.new(attributes || {}, data).to_xml(@metadata)
     end
 
     ####
@@ -70,7 +66,7 @@ module InspecTools
     #
     # @param inspec_json : an inspec profile formatted as a json object
     ###
-    def inspec_json_to_array(inspec_json)
+    def inspec_json_to_array(inspec_json) # rubocop:disable Metrics/CyclomaticComplexity
       data = []
       headers = {}
       inspec_json['controls'].each do |control|
@@ -97,10 +93,11 @@ module InspecTools
           @data['controls'] << control
         end
       end
-      if json['profiles'].nil?
-        json['controls'].each do |control|
-          @data['controls'] << control
-        end
+
+      return unless json['profiles'].nil?
+
+      json['controls'].each do |control|
+        @data['controls'] << control
       end
     end
 
@@ -161,7 +158,7 @@ module InspecTools
       vuln
     end
 
-    def generate_asset
+    def generate_asset # rubocop:disable Metrics/AbcSize
       asset = HappyMapperTools::StigChecklist::Asset.new
       asset.role = !@metadata['role'].nil? ? @metadata['role'] : 'Workstation'
       asset.type = !@metadata['type'].nil? ? @metadata['type'] : 'Computing'
@@ -223,75 +220,6 @@ module InspecTools
       ip
     end
 
-    def populate_header
-      @benchmark.title = @attribute['benchmark.title']
-      @benchmark.id = @attribute['benchmark.id']
-      @benchmark.description = @attribute['benchmark.description']
-      @benchmark.version = @attribute['benchmark.version']
-
-      @benchmark.status = HappyMapperTools::Benchmark::Status.new
-      @benchmark.status.status = @attribute['benchmark.status']
-      @benchmark.status.date = @attribute['benchmark.status.date']
-
-      @benchmark.notice = HappyMapperTools::Benchmark::Notice.new
-      @benchmark.notice.id = @attribute['benchmark.notice.id']
-
-      @benchmark.plaintext = HappyMapperTools::Benchmark::Plaintext.new
-      @benchmark.plaintext.plaintext = @attribute['benchmark.plaintext']
-      @benchmark.plaintext.id = @attribute['benchmark.plaintext.id']
-
-      @benchmark.reference = HappyMapperTools::Benchmark::ReferenceBenchmark.new
-      @benchmark.reference.href = @attribute['reference.href']
-      @benchmark.reference.dc_publisher = @attribute['reference.dc.publisher']
-      @benchmark.reference.dc_source = @attribute['reference.dc.source']
-    end
-
-    def populate_groups
-      group_array = []
-      @data['controls'].each do |control|
-        group = HappyMapperTools::Benchmark::Group.new
-        group.id = control['id']
-        group.title = control['gtitle']
-        group.description = "<GroupDescription>#{control['gdescription']}</GroupDescription>"
-
-        group.rule = HappyMapperTools::Benchmark::Rule.new
-        group.rule.id = control['rid']
-        group.rule.severity = control['severity']
-        group.rule.weight = control['rweight']
-        group.rule.version = control['rversion']
-        group.rule.title = control['title'].tr("\n", ' ')
-        group.rule.description = "<VulnDiscussion>#{control['desc'].tr("\n", ' ')}</VulnDiscussion><FalsePositives></FalsePositives><FalseNegatives></FalseNegatives><Documentable>false</Documentable><Mitigations></Mitigations><SeverityOverrideGuidance></SeverityOverrideGuidance><PotentialImpacts></PotentialImpacts><ThirdPartyTools></ThirdPartyTools><MitigationControl></MitigationControl><Responsibility></Responsibility><IAControls></IAControls>"
-
-        group.rule.reference = HappyMapperTools::Benchmark::ReferenceGroup.new
-        group.rule.reference.dc_publisher = @attribute['reference.dc.publisher']
-        group.rule.reference.dc_title = @attribute['reference.dc.title']
-        group.rule.reference.dc_subject = @attribute['reference.dc.subject']
-        group.rule.reference.dc_type = @attribute['reference.dc.type']
-        group.rule.reference.dc_identifier = @attribute['reference.dc.identifier']
-
-        group.rule.ident = HappyMapperTools::Benchmark::Ident.new
-        group.rule.ident.system = 'https://public.cyber.mil/stigs/cci/'
-        group.rule.ident.ident = control['cci']
-
-        group.rule.fixtext = HappyMapperTools::Benchmark::Fixtext.new
-        group.rule.fixtext.fixref = control['fixref']
-        group.rule.fixtext.fixtext = control['fix']
-
-        group.rule.fix = HappyMapperTools::Benchmark::Fix.new
-        group.rule.fix.id = control['fixref']
-
-        group.rule.check = HappyMapperTools::Benchmark::Check.new
-        group.rule.check.system = control['checkref']
-        group.rule.check.content_ref = HappyMapperTools::Benchmark::ContentRef.new
-        group.rule.check.content_ref.name = @attribute['content_ref.name']
-        group.rule.check.content_ref.href = @attribute['content_ref.href']
-        group.rule.check.content = control['check']
-
-        group_array << group
-      end
-      @benchmark.group = group_array
-    end
-
     def generate_title(title, json, date)
       title ||= "Untitled - Checklist Created from Automated InSpec Results JSON; Profiles: #{json['profiles'].map { |x| x['name'] }.join(' | ')}"
       title + " Checklist Date: #{date || Date.today.to_s}"

data/lib/inspec_tools/pdf.rb

@@ -2,9 +2,9 @@ require 'digest'
 
 require_relative '../utilities/inspec_util'
 require_relative '../utilities/extract_pdf_text'
-require_relative '../utilities/extract_nist_cis_mapping'
 require_relative '../utilities/parser'
 require_relative '../utilities/text_cleaner'
+require_relative '../utilities/cis_to_nist'
 
 # rubocop:disable Metrics/AbcSize
 # rubocop:disable Metrics/PerceivedComplexity
@@ -24,7 +24,7 @@ module InspecTools
       @controls = []
       @csv_handle = nil
       @cci_xml = nil
-      @nist_mapping = nil
+      @nist_mapping = Utils::CisToNist.get_mapping('cis_to_nist_critical_controls')
       @pdf_text = ''
       @clean_text = ''
       @transformed_data = ''
@@ -33,7 +33,6 @@ module InspecTools
       @title ||= extract_title
       clean_pdf_text
       transform_data
-      read_excl
       insert_json_metadata
       @profile['controls'] = parse_controls
       @profile['sha256'] = Digest::SHA256.hexdigest @profile.to_s
@@ -122,15 +121,5 @@ module InspecTools
     def write_clean_text
       File.write('debug_text', @clean_text)
     end
-
-    def read_excl
-      nist_map_path = File.join(File.dirname(__FILE__), '../data/NIST_Map_09212017B_CSC-CIS_Critical_Security_Controls_VER_6.1_Excel_9.1.2016.xlsx')
-      excel = Util::ExtractNistMappings.new(nist_map_path)
-      @nist_mapping = excel.full_excl
-    rescue StandardError => e
-      puts "Exception: #{e.message}"
-      puts 'Existing...'
-      exit
-    end
   end
 end

data/lib/inspec_tools/plugin_cli.rb

@@ -1,4 +1,3 @@
-require 'yaml'
 require 'json'
 require 'roo'
 require_relative '../utilities/inspec_util'
@@ -13,8 +12,8 @@ module InspecTools
   autoload :CKL, 'inspec_tools/ckl'
   autoload :Inspec, 'inspec_tools/inspec'
   autoload :Summary, 'inspec_tools/summary'
-  autoload :Threshold, 'inspec_tools/threshold'
   autoload :XLSXTool, 'inspec_tools/xlsx_tool'
+  autoload :GenerateMap, 'inspec_tools/generate_map'
 end
 
 # rubocop:disable Style/GuardClause
@@ -23,7 +22,7 @@ module InspecPlugins
     class CliCommand < Inspec.plugin(2, :cli_command) # rubocop:disable Metrics/ClassLength
       POSSIBLE_LOG_LEVELS = %w{debug info warn error fatal}.freeze
 
-      class_option :log_directory, type: :string, aliases: :l, desc: 'Provie log location'
+      class_option :log_directory, type: :string, aliases: :l, desc: 'Provide log location'
       class_option :log_level, type: :string, desc: "Set the logging level: #{POSSIBLE_LOG_LEVELS}"
 
       subcommand_desc 'tools [COMMAND]', 'Runs inspec_tools commands through Inspec'
@@ -54,12 +53,18 @@ module InspecPlugins
 
       desc 'inspec2xccdf', 'inspec2xccdf translates an inspec profile and attributes files to an xccdf file'
       long_desc InspecTools::Help.text(:inspec2xccdf)
-      option :inspec_json, required: true, aliases: '-j'
-      option :attributes,  required: true, aliases: '-a'
-      option :output, required: true, aliases: '-o'
+      option :inspec_json, required: true, aliases: '-j',
+                           desc: 'path to InSpec JSON file created'
+      option :attributes,  required: true, aliases: '-a',
+                           desc: 'path to yml file that provides the required attributes for the XCCDF document. These attributes are parts of XCCDF document which do not fit into the InSpec schema.'
+      option :output, required: true, aliases: '-o',
+                      desc: 'name or path to create the XCCDF and title to give the XCCDF'
+      option :metadata, required: false, type: :string, aliases: '-m',
+                        desc: 'path to JSON file with additional host metadata for the XCCDF file'
       def inspec2xccdf
         json = File.read(options[:inspec_json])
-        inspec_tool = InspecTools::Inspec.new(json)
+        metadata = options[:metadata] ? JSON.parse(File.read(options[:metadata])) : {}
+        inspec_tool = InspecTools::Inspec.new(json, metadata)
         attr_hsh = YAML.load_file(options[:attributes])
         xccdf = inspec_tool.to_xccdf(attr_hsh)
         File.write(options[:output], xccdf)
@@ -73,10 +78,11 @@ module InspecPlugins
       option :output, required: false, aliases: '-o', default: 'profile'
       option :format, required: false, aliases: '-f', enum: %w{ruby hash}, default: 'ruby'
       option :separate_files, required: false, type: :boolean, default: true, aliases: '-s'
+      option :control_name_prefix, required: false, type: :string, aliases: '-p'
       def csv2inspec
         csv = CSV.read(options[:csv], encoding: 'ISO8859-1')
         mapping = YAML.load_file(options[:mapping])
-        profile = InspecTools::CSVTool.new(csv, mapping, options[:csv].split('/')[-1].split('.')[0], options[:verbose]).to_inspec
+        profile = InspecTools::CSVTool.new(csv, mapping, options[:csv].split('/')[-1].split('.')[0], options[:verbose]).to_inspec(control_name_prefix: options[:control_name_prefix])
         Utils::InspecUtil.unpack_inspec_json(options[:output], profile, options[:separate_files], options[:format])
       end
 
@@ -136,26 +142,8 @@ module InspecPlugins
 
       desc 'generate_map', 'Generates mapping template from CSV to Inspec Controls'
       def generate_map
-        template = '
-        # Setting csv_header to true will skip the csv file header
-        skip_csv_header: true
-        width   : 80
-
-
-        control.id: 0
-        control.title: 15
-        control.desc: 16
-        control.tags:
-                severity: 1
-                rid: 8
-                stig_id: 3
-                cci: 2
-                check: 12
-                fix: 10
-        '
-        myfile = File.new('mapping.yml', 'w')
-        myfile.puts template
-        myfile.close
+        generator = InspecTools::GenerateMap.new
+        generator.generate_example('mapping.yml')
       end
 
       desc 'generate_ckl_metadata', 'Generate metadata file that can be passed to inspec2ckl'
@@ -200,26 +188,14 @@ module InspecPlugins
       desc 'summary', 'summary parses an inspec results json to create a summary json'
       long_desc InspecTools::Help.text(:summary)
       option :inspec_json, required: true, aliases: '-j'
-      option :verbose, type: :boolean, aliases: '-V'
       option :json_full, type: :boolean, required: false, aliases: '-f'
       option :json_counts, type: :boolean, required: false, aliases: '-k'
+      option :threshold_file, required: false, aliases: '-t'
+      option :threshold_inline, required: false, aliases: '-i'
 
       def summary
-        summary = InspecTools::Summary.new(File.read(options[:inspec_json])).to_summary
-
-        unless options.include?('json_full') || options.include?('json_counts')
-          puts "\nOverall compliance: #{summary[:compliance]}%\n\n"
-          summary[:status].keys.each do |category|
-            puts category
-            summary[:status][category].keys.each do |impact|
-              puts "\t#{impact} : #{summary[:status][category][impact]}"
-            end
-          end
-        end
-
-        json_summary = summary.to_json
-        puts json_summary if options[:json_full]
-        puts summary[:status].to_json if options[:json_counts]
+        summary = InspecTools::Summary.new(options: options)
+        summary.output_summary
       end
 
       desc 'compliance', 'compliance parses an inspec results json to check if the compliance level meets a specified threshold'
@@ -227,17 +203,10 @@ module InspecPlugins
       option :inspec_json, required: true, aliases: '-j'
       option :threshold_file, required: false, aliases: '-f'
       option :threshold_inline, required: false, aliases: '-i'
-      option :verbose, type: :boolean, aliases: '-V'
 
       def compliance
-        if options[:threshold_file].nil? && options[:threshold_inline].nil?
-          puts 'Please provide threshold as a yaml file or inline yaml'
-          exit(1)
-        end
-        threshold = YAML.load_file(options[:threshold_file]) unless options[:threshold_file].nil?
-        threshold = YAML.safe_load(options[:threshold_inline]) unless options[:threshold_inline].nil?
-        compliance = InspecTools::Summary.new(File.read(options[:inspec_json])).threshold(threshold)
-        compliance ? exit(0) : exit(1)
+        compliance = InspecTools::Summary.new(options: options)
+        compliance.results_meet_threshold? ? exit(0) : exit(1)
       end
     end
   end

data/lib/inspec_tools/summary.rb

@@ -2,8 +2,6 @@ require 'json'
 require 'yaml'
 require_relative '../utilities/inspec_util'
 
-# rubocop:disable Metrics/AbcSize
-
 # Impact Definitions
 CRITICAL = 0.9
 HIGH = 0.7
@@ -16,48 +14,118 @@ TALLYS = %i(total critical high medium low).freeze
 THRESHOLD_TEMPLATE = File.expand_path('../data/threshold.yaml', File.dirname(__FILE__))
 
 module InspecTools
+  # rubocop:disable Metrics/ClassLength
   class Summary
-    def initialize(inspec_json)
-      @json = JSON.parse(inspec_json)
+    attr_reader :json
+    attr_reader :json_full
+    attr_reader :json_counts
+    attr_reader :threshold_file
+    attr_reader :threshold_inline
+    attr_reader :summary
+    attr_reader :threshold
+
+    def initialize(**options)
+      options = options[:options]
+      @json = JSON.parse(File.read(options[:inspec_json]))
+      @json_full = false || options[:json_full]
+      @json_counts = false || options[:json_counts]
+      @threshold = parse_threshold(options[:threshold_inline], options[:threshold_file])
+      @threshold_provided = options[:threshold_inline] || options[:threshold_file]
+      @summary = compute_summary
     end
 
-    def to_summary
-      @data = Utils::InspecUtil.parse_data_for_ckl(@json)
-      @summary = {}
-      @data.keys.each do |control_id|
-        current_control = @data[control_id]
-        current_control[:compliance_status] = Utils::InspecUtil.control_status(current_control, true)
-        current_control[:finding_details] = Utils::InspecUtil.control_finding_details(current_control, current_control[:compliance_status])
+    def output_summary
+      unless @json_full || @json_counts
+        puts "\nThreshold compliance: #{@threshold['compliance.min']}%"
+        puts "\nOverall compliance: #{@summary[:compliance]}%\n\n"
+        @summary[:status].keys.each do |category|
+          puts category
+          @summary[:status][category].keys.each do |impact|
+            puts "\t#{impact} : #{@summary[:status][category][impact]}"
+          end
+        end
       end
-      compute_summary
-      @summary
+
+      puts @summary.to_json if @json_full
+      puts @summary[:status].to_json if @json_counts
     end
 
-    def threshold(threshold = nil)
-      @summary = to_summary
-      @threshold = Utils::InspecUtil.to_dotted_hash(YAML.load_file(THRESHOLD_TEMPLATE))
-      parse_threshold(Utils::InspecUtil.to_dotted_hash(threshold))
-      threshold_compliance
+    def results_meet_threshold?
+      raise 'Please provide threshold as a yaml file or inline yaml' unless @threshold_provided
+
+      compliance = true
+      failure = []
+      failure << check_max_compliance(@threshold['compliance.max'], @summary[:compliance], '', 'compliance')
+      failure << check_min_compliance(@threshold['compliance.min'], @summary[:compliance], '', 'compliance')
+
+      BUCKETS.each do |bucket|
+        TALLYS.each do |tally|
+          failure << check_min_compliance(@threshold["#{bucket}.#{tally}.min"], @summary[:status][bucket][tally], bucket, tally)
+          failure << check_max_compliance(@threshold["#{bucket}.#{tally}.max"], @summary[:status][bucket][tally], bucket, tally)
+        end
+      end
+
+      failure.reject!(&:nil?)
+      compliance = false if failure.length.positive?
+      output(compliance, failure)
+      compliance
     end
 
     private
 
+    def check_min_compliance(min, data, bucket, tally)
+      expected_to_string(bucket, tally, 'min', min, data) if min != -1 and data < min
+    end
+
+    def check_max_compliance(max, data, bucket, tally)
+      expected_to_string(bucket, tally, 'max', max, data) if max != -1 and data > max
+    end
+
+    def output(passed_threshold, what_failed)
+      if passed_threshold
+        puts "Overall compliance threshold of #{@threshold['compliance.min']}\% met. Current compliance at #{@summary[:compliance]}\%"
+      else
+        puts 'Compliance threshold was not met: '
+        puts what_failed.join("\n")
+      end
+    end
+
+    def expected_to_string(bucket, tally, maxmin, value, got)
+      return "Expected #{bucket}.#{tally}.#{maxmin}:#{value} got:#{got}" unless bucket.empty? || bucket.nil?
+
+      "Expected #{tally}.#{maxmin}:#{value}\% got:#{got}\%"
+    end
+
+    def parse_threshold(threshold_inline, threshold_file)
+      threshold = Utils::InspecUtil.to_dotted_hash(YAML.load_file(THRESHOLD_TEMPLATE))
+      threshold.merge!(Utils::InspecUtil.to_dotted_hash(YAML.load_file(threshold_file))) if threshold_file
+      threshold.merge!(Utils::InspecUtil.to_dotted_hash(YAML.safe_load(threshold_inline))) if threshold_inline
+      threshold
+    end
+
     def compute_summary
-      @summary[:buckets] = {}
-      @summary[:buckets][:failed]    = select_by_status(@data, 'Open')
-      @summary[:buckets][:passed]    = select_by_status(@data, 'NotAFinding')
-      @summary[:buckets][:no_impact] = select_by_status(@data, 'Not_Applicable')
-      @summary[:buckets][:skipped]   = select_by_status(@data, 'Not_Reviewed')
-      @summary[:buckets][:error]     = select_by_status(@data, 'Profile_Error')
-
-      @summary[:status] = {}
-      @summary[:status][:failed]    = tally_by_impact(@summary[:buckets][:failed])
-      @summary[:status][:passed]    = tally_by_impact(@summary[:buckets][:passed])
-      @summary[:status][:no_impact] = tally_by_impact(@summary[:buckets][:no_impact])
-      @summary[:status][:skipped]   = tally_by_impact(@summary[:buckets][:skipped])
-      @summary[:status][:error]     = tally_by_impact(@summary[:buckets][:error])
-
-      @summary[:compliance] = compute_compliance
+      data = Utils::InspecUtil.parse_data_for_ckl(@json)
+
+      data.keys.each do |control_id|
+        current_control = data[control_id]
+        current_control[:compliance_status] = Utils::InspecUtil.control_status(current_control, true)
+        current_control[:finding_details] = Utils::InspecUtil.control_finding_details(current_control, current_control[:compliance_status])
+      end
+
+      summary = {}
+      summary[:buckets] = {}
+      summary[:buckets][:failed]    = select_by_status(data, 'Open')
+      summary[:buckets][:passed]    = select_by_status(data, 'NotAFinding')
+      summary[:buckets][:no_impact] = select_by_status(data, 'Not_Applicable')
+      summary[:buckets][:skipped]   = select_by_status(data, 'Not_Reviewed')
+      summary[:buckets][:error]     = select_by_status(data, 'Profile_Error')
+
+      summary[:status] = {}
+      %i(failed passed no_impact skipped error).each do |key|
+        summary[:status][key] = tally_by_impact(summary[:buckets][key])
+      end
+      summary[:compliance] = compute_compliance(summary)
+      summary
     end
 
     def select_by_impact(controls, impact)
@@ -78,49 +146,13 @@ module InspecTools
       tally
     end
 
-    def compute_compliance
-      (@summary[:status][:passed][:total]*100.0/
-        (@summary[:status][:passed][:total]+
-         @summary[:status][:failed][:total]+
-         @summary[:status][:skipped][:total]+
-         @summary[:status][:error][:total])).floor
-    end
-
-    def threshold_compliance
-      compliance = true
-      failure = []
-      max = @threshold['compliance.max']
-      min = @threshold['compliance.min']
-      if max != -1 and @summary[:compliance] > max
-        compliance = false
-        failure << "Expected compliance.max:#{max} got:#{@summary[:compliance]}"
-      end
-      if min != -1 and @summary[:compliance] < min
-        compliance = false
-        failure << "Expected compliance.min:#{min} got:#{@summary[:compliance]}"
-      end
-      status = @summary[:status]
-      BUCKETS.each do |bucket|
-        TALLYS.each do |tally|
-          max = @threshold["#{bucket}.#{tally}.max"]
-          min = @threshold["#{bucket}.#{tally}.min"]
-          if max != -1 and status[bucket][tally] > max
-            compliance = false
-            failure << "Expected #{bucket}.#{tally}.max:#{max} got:#{status[bucket][tally]}"
-          end
-          if min != -1 and status[bucket][tally] < min
-            compliance = false
-            failure << "Expected #{bucket}.#{tally}.min:#{min} got:#{status[bucket][tally]}"
-          end
-        end
-      end
-      puts failure.join("\n") unless compliance
-      puts 'Compliance threshold met' if compliance
-      compliance
-    end
-
-    def parse_threshold(new_threshold)
-      @threshold.merge!(new_threshold)
+    def compute_compliance(summary)
+      (summary[:status][:passed][:total]*100.0/
+        (summary[:status][:passed][:total]+
+         summary[:status][:failed][:total]+
+         summary[:status][:skipped][:total]+
+         summary[:status][:error][:total])).floor
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end