Class: InspecPlugins::InspecToolsPlugin::CliCommand

Inherits:

Object

• Object
• InspecPlugins::InspecToolsPlugin::CliCommand

Defined in:

lib/inspec_tools/plugin_cli.rb

Overview

rubocop:disable Metrics/ClassLength

Constant Summary

POSSIBLE_LOG_LEVELS =

%w{debug info warn error fatal}.freeze

Instance Method Summary

• #compliance ⇒ Object
• #csv2inspec ⇒ Object
• #generate_ckl_metadata ⇒ Object
• #generate_inspec_metadata ⇒ Object
• #generate_map ⇒ Object
• #inspec2ckl ⇒ Object
• #inspec2csv ⇒ Object
• #inspec2xccdf ⇒ Object
• #pdf2inspec ⇒ Object
• #summary ⇒ Object
• #xccdf2inspec ⇒ Object
• #xlsx2inspec ⇒ Object

Instance Method Details

#compliance ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 221

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)
end

#csv2inspec ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 83

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
  Utils::InspecUtil.unpack_inspec_json(options[:output], profile, options[:separate_files], options[:format])
end

#generate_ckl_metadata ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 151

def generate_ckl_metadata
  metadata = {}

  metadata['stigid'] = ask('STID ID: ')
  metadata['role'] = ask('Role: ')
  metadata['type'] = ask('Type: ')
  metadata['hostname'] = ask('Hostname: ')
  metadata['ip'] = ask('IP Address: ')
  metadata['mac'] = ask('MAC Address: ')
  metadata['fqdn'] = ask('FQDN: ')
  metadata['tech_area'] = ask('Tech Area: ')
  metadata['target_key'] = ask('Target Key: ')
  metadata['web_or_database'] = ask('Web or Database: ')
  metadata['web_db_site'] = ask('Web DB Site: ')
  metadata['web_db_instance'] = ask('Web DB Instance: ')

  metadata.delete_if { |_key, value| value.empty? }
  File.open('metadata.json', 'w') do |f|
    f.write(metadata.to_json)
  end
end

#generate_inspec_metadata ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 174

def generate_inspec_metadata
  metadata = {}

  metadata['maintainer'] = ask('Maintainer: ')
  metadata['copyright'] = ask('Copyright: ')
  metadata['copyright_email'] = ask('Copyright Email: ')
  metadata['license'] = ask('License: ')
  metadata['version'] = ask('Version: ')

  metadata.delete_if { |_key, value| value.empty? }
  File.open('metadata.json', 'w') do |f|
    f.write(metadata.to_json)
  end
end

#generate_map ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 145

def generate_map
  generator = InspecTools::GenerateMap.new
  generator.generate_example('mapping.yml')
end

#inspec2ckl ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 122

def inspec2ckl
  metadata = '{}'
  if !options[:metadata].nil?
    metadata = File.read(options[:metadata])
  end
  ckl = InspecTools::Inspec.new(File.read(options[:inspec_json]), metadata).to_ckl
  File.write(options[:output], ckl)
end

#inspec2csv ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 111

def inspec2csv
  csv = InspecTools::Inspec.new(File.read(options[:inspec_json])).to_csv
  Utils::CSVUtil.unpack_csv(csv, options[:output])
end

#inspec2xccdf ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 66

def inspec2xccdf
  json = File.read(options[:inspec_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)
end

#pdf2inspec ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 138

def pdf2inspec
  pdf = File.open(options[:pdf])
  profile = InspecTools::PDF.new(pdf, options[:output], options[:debug]).to_inspec
  Utils::InspecUtil.unpack_inspec_json(options[:output], profile, options[:separate_files], options[:format])
end

#summary ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 196

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]
end

#xccdf2inspec ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 41

def xccdf2inspec
  xccdf = InspecTools::XCCDF.new(File.read(options[:xccdf]), options[:replace_tags])
  profile = xccdf.to_inspec

  if !options[:metadata].nil?
    xccdf.inject_metadata(File.read(options[:metadata]))
  end

  Utils::InspecUtil.unpack_inspec_json(options[:output], profile, options[:separate_files], options[:format])
  if !options[:attributes].nil?
    attributes = xccdf.to_attributes
    File.write(options[:attributes], YAML.dump(attributes))
  end
end

#xlsx2inspec ⇒ Object

# File 'lib/inspec_tools/plugin_cli.rb', line 99

def xlsx2inspec
  xlsx = Roo::Spreadsheet.open(options[:xlsx])
  mapping = YAML.load_file(options[:mapping])
  profile = InspecTools::XLSXTool.new(xlsx, mapping, options[:xlsx].split('/')[-1].split('.')[0], options[:verbose]).to_inspec(options[:control_name_prefix])
  Utils::InspecUtil.unpack_inspec_json(options[:output], profile, options[:separate_files], options[:format])
end