inspec_tools 0.0.0.1.ENOTAG

data/lib/inspec_tools/help.rb

@@ -0,0 +1,9 @@
+module InspecTools::Help
+  class << self
+    def text(namespaced_command)
+      path = namespaced_command.to_s.tr(':', '/')
+      path = File.expand_path("../help/#{path}.md", __FILE__)
+      IO.read(path) if File.exist?(path)
+    end
+  end
+end

data/lib/inspec_tools/help/compliance.md

@@ -0,0 +1,7 @@
+  compliance parses an inspec results json to check if the compliance level meets a specified threshold
+  
+Examples:
+
+  inspec_tools compliance -j examples/sample_json/rhel-simp.json -i '{compliance.min: 80, failed.critical.max: 0, failed.high.max: 0}'
+
+  inspec_tools compliance -j examples/sample_json/rhel-simp.json -f examples/sample_yaml/threshold.yaml

data/lib/inspec_tools/help/csv2inspec.md

@@ -0,0 +1,5 @@
+  csv2inspec translates CSV to Inspec controls using a mapping file
+  
+Examples:
+
+  inspec_tools csv2inspec -m examples/csv2inspec/mapping.yml -c examples/csv2inspec/stig.csv

data/lib/inspec_tools/help/inspec2ckl.md

@@ -0,0 +1,5 @@
+  inspec2ckl translates an inspec json file to a Checklist file
+
+Examples:
+
+  inspec_tools inspec2ckl -j examples/sample_json/good_nginxresults.json -o output.ckl

data/lib/inspec_tools/help/inspec2csv.md

@@ -0,0 +1,5 @@
+  inspec2csv translates Inspec controls to CSV
+  
+ Examples:
+
+  inspec_tools inspec2csv -j examples/sample_json/good_nginxresults.json -o output.csv

data/lib/inspec_tools/help/inspec2xccdf.md

@@ -0,0 +1,5 @@
+  inspec2xccdf translates an inspec profile and attributes files to an xccdf file
+  
+Examples:
+
+  inspec_tools inspec2xccdf -j examples/sample_json/good_nginxresults.json -a lib/data/attributes.yml -o output.xccdf

data/lib/inspec_tools/help/pdf2inspec.md

@@ -0,0 +1,6 @@
+  pdf2inspec translates a PDF Security Control Speficication to Inspec Security Profile
+  
+Examples:
+
+  inspec_tools pdf2inspec -p examples/CIS_Ubuntu_Linux_16.04_LTS_Benchmark_v1.0.0.pdf
+  inspec_tools pdf2inspec -p examples/CIS_Ubuntu_Linux_16.04_LTS_Benchmark_v1.0.0.pdf -o CIS_Ubuntu_Linux_16.04_LTS_Benchmark_v1.0.0

data/lib/inspec_tools/help/summary.md

@@ -0,0 +1,5 @@
+  summary parses an inspec results json to create a summary json
+
+Examples:
+
+  inspec_tools summary -j examples/sample_json/rhel-simp.json -f -o summary.json

data/lib/inspec_tools/help/xccdf2inspec.md

@@ -0,0 +1,5 @@
+  xccdf2inspec translates an xccdf file to an inspec profile
+
+Examples:
+
+  inspec_tools xccdf2inspec -x examples/xccdf2inspec/xccdf.xml -o myprofile

data/lib/inspec_tools/inspec.rb

@@ -0,0 +1,331 @@
+require 'date'
+require 'json'
+require 'cgi'
+require 'csv'
+require 'yaml'
+require 'pp'
+require_relative '../happy_mapper_tools/stig_attributes'
+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
+
+module InspecTools
+  class Inspec
+    def initialize(inspec_json, metadata = '{}')
+      @json = JSON.parse(inspec_json.gsub(/\\+u0000/, ''))
+      @metadata = JSON.parse(metadata)
+    end
+
+    def to_ckl(title = nil, date = nil, cklist = nil)
+      @data = Utils::InspecUtil.parse_data_for_ckl(@json)
+      @platform = Utils::InspecUtil.get_platform(@json)
+      @title = generate_title title, @json, date
+      @cklist = cklist
+      @checklist = HappyMapperTools::StigChecklist::Checklist.new
+      if @cklist.nil?
+        generate_ckl
+      else
+        update_ckl
+      end
+      @checklist.to_xml.encode('UTF-8').gsub('<?xml version="1.0"?>', '<?xml version="1.0" encoding="UTF-8"?>').chomp
+    end
+
+    def to_xccdf(attributes, verbose = false)
+      @data = Utils::InspecUtil.parse_data_for_xccdf(@json)
+      @attribute = attributes
+      @attribute = {} if @attribute.eql? false
+      @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
+    end
+
+    ####
+    # converts an InSpec JSON to a CSV file
+    ###
+    def to_csv
+      @data = {}
+      @data['controls'] = []
+      get_all_controls_from_json(@json)
+      data = inspec_json_to_array(@data)
+      CSV.generate do |csv|
+        data.each do |row|
+          csv << row
+        end
+      end
+    end
+
+    private
+
+    ###
+    #  This method converts an inspec json to an array of arrays
+    #
+    # @param inspec_json : an inspec profile formatted as a json object
+    ###
+    def inspec_json_to_array(inspec_json)
+      data = []
+      headers = {}
+      inspec_json['controls'].each do |control|
+        control.each do |key, _|
+          control['tags'].each { |tag, _| headers[tag] = 0 } if key == 'tags'
+          control['results'].each { |result| result.each { |result_key, _| headers[result_key] = 0 } } if key == 'results'
+          headers[key] = 0 unless %w{tags results}.include?(key)
+        end
+      end
+      data.push(headers.keys)
+      inspec_json['controls'].each do |json_control|
+        control = []
+        headers.each do |key, _|
+          control.push(json_control[key] || json_control['tags'][key] || json_control['results']&.collect { |result| result[key] }&.join(",\n") || nil)
+        end
+        data.push(control)
+      end
+      data
+    end
+
+    def get_all_controls_from_json(json)
+      json['profiles']&.each do |profile|
+        profile['controls'].each do |control|
+          @data['controls'] << control
+        end
+      end
+      if json['profiles'].nil?
+        json['controls'].each do |control|
+          @data['controls'] << control
+        end
+      end
+    end
+
+    def update_ckl
+      @checklist = HappyMapperTools::StigChecklist::Checklist.parse(@cklist.to_s)
+      @data.keys.each do |control_id|
+        vuln = @checklist.where('Vuln_Num', control_id.to_s)
+        vuln.status = Utils::InspecUtil.control_status(@data[control_id])
+        vuln.finding_details << Utils::InspecUtil.control_finding_details(@data[control_id], vuln.status)
+      end
+    end
+
+    def generate_ckl
+      stigs = HappyMapperTools::StigChecklist::Stigs.new
+      istig = HappyMapperTools::StigChecklist::IStig.new
+
+      vuln_list = []
+      @data.keys.each do |control_id|
+        vuln_list.push(generate_vuln_data(@data[control_id]))
+      end
+
+      si_data = HappyMapperTools::StigChecklist::SiData.new
+      si_data.name = 'stigid'
+      si_data.data = ''
+      if !@metadata['stigid'].nil?
+        si_data.data = @metadata['stigid']
+      end
+
+      stig_info = HappyMapperTools::StigChecklist::StigInfo.new
+      stig_info.si_data = si_data
+      istig.stig_info = stig_info
+
+      istig.vuln = vuln_list
+      stigs.istig = istig
+      @checklist.stig = stigs
+
+      @checklist.asset = generate_asset
+    end
+
+    def generate_vuln_data(control)
+      vuln = HappyMapperTools::StigChecklist::Vuln.new
+      stig_data_list = []
+
+      %w{Vuln_Num Group_Title Rule_ID Rule_Ver Rule_Title Vuln_Discuss Check_Content Fix_Text}.each do |attribute|
+        stig_data_list << create_stig_data_element(attribute, control)
+      end
+      stig_data_list << handle_severity(control)
+      stig_data_list += handle_cci_ref(control)
+      stig_data_list << handle_stigref
+
+      vuln.stig_data = stig_data_list.reject(&:nil?)
+      vuln.status = Utils::InspecUtil.control_status(control)
+      vuln.comments = "\nAutomated compliance tests brought to you by the MITRE corporation and the InSpec project.\n\nInspec Profile: #{control[:profile_name]}\nProfile shasum: #{control[:profile_shasum]}"
+      vuln.finding_details = Utils::InspecUtil.control_finding_details(control, vuln.status)
+      vuln.severity_override = ''
+      vuln.severity_justification = ''
+
+      vuln
+    end
+
+    def generate_asset
+      asset = HappyMapperTools::StigChecklist::Asset.new
+      asset.role = !@metadata['role'].nil? ? @metadata['role'] : 'Workstation'
+      asset.type = !@metadata['type'].nil? ? @metadata['type'] : 'Computing'
+      asset.host_name = generate_hostname
+      asset.host_ip = generate_ip
+      asset.host_mac = generate_mac
+      asset.host_fqdn = generate_fqdn
+      asset.tech_area = !@metadata['tech_area'].nil? ? @metadata['tech_area'] : ''
+      asset.target_key = !@metadata['target_key'].nil? ? @metadata['target_key'] : ''
+      asset.web_or_database = !@metadata['web_or_database'].nil? ? @metadata['web_or_database'] : '0'
+      asset.web_db_site = !@metadata['web_db_site'].nil? ? @metadata['web_db_site'] : ''
+      asset.web_db_instance = !@metadata['web_db_instance'].nil? ? @metadata['web_db_instance'] : ''
+      asset
+    end
+
+    def generate_hostname
+      hostname = @metadata['hostname']
+      if hostname.nil? && @platform.nil?
+        hostname = ''
+      elsif hostname.nil?
+        hostname = @platform[:hostname]
+      end
+      hostname
+    end
+
+    def generate_mac
+      mac = @metadata['mac']
+      if mac.nil?
+        nics = @platform.nil? ? [] : @platform[:network]
+        nics_macs = []
+        nics.each do |nic|
+          nics_macs.push(nic[:mac])
+        end
+        mac = nics_macs.join(',')
+      end
+      mac
+    end
+
+    def generate_fqdn
+      fqdn = @metadata['fqdn']
+      if fqdn.nil? && @platform.nil?
+        fqdn = ''
+      elsif fqdn.nil?
+        fqdn = @platform[:fqdn]
+      end
+      fqdn
+    end
+
+    def generate_ip
+      ip = @metadata['ip']
+      if ip.nil?
+        nics = @platform.nil? ? [] : @platform[:network]
+        nics_ips = []
+        nics.each do |nic|
+          nics_ips.push(*nic[:ip])
+        end
+        ip = nics_ips.join(',')
+      end
+      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}"
+    end
+
+    def create_stig_data_element(attribute, control)
+      return HappyMapperTools::StigChecklist::StigData.new(attribute, control[attribute.downcase.to_sym]) unless control[attribute.downcase.to_sym].nil?
+    end
+
+    def handle_severity(control)
+      return if control[:impact].nil?
+
+      value = Utils::InspecUtil.get_impact_string(control[:impact], use_cvss_terms: false)
+      return if value == 'none'
+
+      HappyMapperTools::StigChecklist::StigData.new('Severity', value)
+    end
+
+    def handle_cci_ref(control)
+      return [] if control[:cci_ref].nil?
+
+      cci_data = []
+      if control[:cci_ref].respond_to?(:each)
+        control[:cci_ref].each do |cci_number|
+          cci_data << HappyMapperTools::StigChecklist::StigData.new('CCI_REF', cci_number)
+        end
+        cci_data
+      else
+        cci_data << HappyMapperTools::StigChecklist::StigData.new('CCI_REF', control[:cci_ref])
+      end
+    end
+
+    def handle_stigref
+      HappyMapperTools::StigChecklist::StigData.new('STIGRef', @title)
+    end
+  end
+end

data/lib/inspec_tools/pdf.rb

@@ -0,0 +1,136 @@
+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'
+
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/PerceivedComplexity
+# rubocop:disable Metrics/CyclomaticComplexity
+
+module InspecTools
+  class PDF
+    def initialize(pdf, profile_name, debug = false)
+      raise ArgumentError if pdf.nil?
+
+      @pdf = pdf
+      @name = profile_name
+      @debug = debug
+    end
+
+    def to_inspec
+      @controls = []
+      @csv_handle = nil
+      @cci_xml = nil
+      @nist_mapping = nil
+      @pdf_text = ''
+      @clean_text = ''
+      @transformed_data = ''
+      @profile = {}
+      read_pdf
+      @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
+      @profile
+    end
+
+    def to_csv
+      # TODO: to_csv
+    end
+
+    def to_xccdf
+      # TODO: to_xccdf
+    end
+
+    def to_ckl
+      # TODO: to_ckl
+    end
+
+    private
+
+    # converts passed in data into InSpec format
+    def parse_controls
+      controls = []
+      @transformed_data.each do |contr|
+        nist = find_nist(contr[:cis]) unless contr[:cis] == 'No CIS Control'
+        control = {}
+        control['id'] = 'M-' + contr[:title].split(' ')[0]
+        control['title'] = contr[:title]
+        control['desc'] = contr[:descr]
+        control['impact'] = Utils::InspecUtil.get_impact('medium')
+        control['tags'] = {}
+        control['tags']['severity'] = Utils::InspecUtil.get_impact_string(control['impact'])
+        control['tags']['ref'] = contr[:ref] unless contr[:ref].nil?
+        control['tags']['applicability'] = contr[:applicability] unless contr[:applicability].nil?
+        control['tags']['cis_id'] = contr[:title].split(' ')[0] unless contr[:title].nil?
+        control['tags']['cis_control'] = [contr[:cis], @nist_mapping[0][:cis_ver]] unless contr[:cis].nil? # tag cis_control: [5, 6.1] ##6.1 is the version
+        control['tags']['cis_level'] = contr[:level] unless contr[:level].nil?
+        control['tags']['nist'] = nist unless nist.nil? # tag nist: [AC-3, 4]  ##4 is the version
+        control['tags']['check'] = contr[:check] unless contr[:check].nil?
+        control['tags']['fix'] = contr[:fix] unless contr[:fix].nil?
+        control['tags']['Default Value'] = contr[:default] unless contr[:default].nil?
+        controls << control
+      end
+      controls
+    end
+
+    def insert_json_metadata
+      @profile['name'] = @name
+      @profile['title'] = @title
+      @profile['maintainer'] = 'The Authors'
+      @profile['copyright'] = 'The Authors'
+      @profile['copyright_email'] = 'you@example.com'
+      @profile['license'] = 'Apache-2.0'
+      @profile['summary'] = 'An InSpec Compliance Profile'
+      @profile['version'] = '0.1.0'
+      @profile['supports'] = []
+      @profile['attributes'] = []
+      @profile['generator'] = {
+        'name': 'inspec_tools',
+        'version': VERSION
+      }
+    end
+
+    def extract_title
+      @pdf_text.match(/([^\n]*)\n/).captures[0]
+    end
+
+    def read_pdf
+      @pdf_text = Util::ExtractPdfText.new(@pdf).extracted_text
+      write_pdf_text if @debug
+    end
+
+    def clean_pdf_text
+      @clean_text = Util::TextCleaner.new.clean_data(@pdf_text)
+      write_clean_text if @debug
+    end
+
+    def transform_data
+      @transformed_data = Util::PrepareData.new(@clean_text).transformed_data
+    end
+
+    def write_pdf_text
+      File.write('pdf_text', @pdf_text)
+    end
+
+    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