mirror of
https://github.com/inspec/inspec
synced 2024-11-23 05:03:07 +00:00
extract base cli class
This commit is contained in:
Christoph Hartmann
parent
30aabc4f42
commit
a55a4869d9
2 changed files with 128 additions and 124 deletions
125
bin/inspec
125
bin/inspec
|
|
@ -7,133 +7,10 @@
|
|||
require 'thor'
|
||||
require 'json'
|
||||
require 'pp'
|
||||
require_relative '../lib/utils/base_cli'
|
||||
require_relative '../lib/inspec'
|
||||
require_relative '../lib/utils/json_log'
|
||||
|
||||
class Inspec::BaseCLI < Thor
|
||||
def self.target_options
|
||||
option :target, aliases: :t, type: :string,
|
||||
desc: 'Simple targeting option using URIs, e.g. ssh://user:pass@host:port'
|
||||
option :backend, aliases: :b, type: :string,
|
||||
desc: 'Choose a backend: local, ssh, winrm, docker.'
|
||||
option :host, type: :string,
|
||||
desc: 'Specify a remote host which is tested.'
|
||||
option :port, aliases: :p, type: :numeric,
|
||||
desc: 'Specify the login port for a remote scan.'
|
||||
option :user, type: :string,
|
||||
desc: 'The login user for a remote scan.'
|
||||
option :password, type: :string,
|
||||
desc: 'Login password for a remote scan, if required.'
|
||||
option :key_files, aliases: :i, type: :array,
|
||||
desc: 'Login key or certificate file for a remote scan.'
|
||||
option :path, type: :string,
|
||||
desc: 'Login path to use when connecting to the target (WinRM).'
|
||||
option :sudo, type: :boolean,
|
||||
desc: 'Run scans with sudo. Only activates on Unix and non-root user.'
|
||||
option :sudo_password, type: :string,
|
||||
desc: 'Specify a sudo password, if it is required.'
|
||||
option :sudo_options, type: :string,
|
||||
desc: 'Additional sudo options for a remote scan.'
|
||||
option :ssl, type: :boolean,
|
||||
desc: 'Use SSL for transport layer encryption (WinRM).'
|
||||
option :self_signed, type: :boolean,
|
||||
desc: 'Allow remote scans with self-signed certificates (WinRM).'
|
||||
option :json_config, type: :string,
|
||||
desc: 'Read configuration from JSON file (`-` reads from stdin).'
|
||||
option :log_level, aliases: :l, type: :string,
|
||||
desc: 'Set the log level: info (default), debug, warn, error'
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# helper method to run tests
|
||||
def run_tests(opts, tests)
|
||||
o = opts.dup
|
||||
o[:logger] = Logger.new(opts['format'] == 'json' ? nil : STDOUT)
|
||||
o[:logger].level = get_log_level(o.log_level)
|
||||
|
||||
runner = Inspec::Runner.new(o)
|
||||
runner.add_tests(tests)
|
||||
exit runner.run
|
||||
rescue RuntimeError => e
|
||||
puts e.message
|
||||
end
|
||||
|
||||
def diagnose
|
||||
return unless opts['diagnose']
|
||||
puts "InSpec version: #{Inspec::VERSION}"
|
||||
puts "Train version: #{Train::VERSION}"
|
||||
puts 'Command line configuration:'
|
||||
pp options
|
||||
puts 'JSON configuration file:'
|
||||
pp options_json
|
||||
puts 'Merged configuration:'
|
||||
pp opts
|
||||
puts
|
||||
end
|
||||
|
||||
def opts
|
||||
# argv overrides json
|
||||
Thor::CoreExt::HashWithIndifferentAccess.new(options_json.merge(options))
|
||||
end
|
||||
|
||||
def options_json
|
||||
conffile = options['json_config']
|
||||
@json ||= conffile ? read_config(conffile) : {}
|
||||
end
|
||||
|
||||
def read_config(file)
|
||||
if file == '-'
|
||||
puts 'WARN: reading JSON config from standard input' if STDIN.tty?
|
||||
config = STDIN.read
|
||||
else
|
||||
config = File.read(file)
|
||||
end
|
||||
|
||||
JSON.load(config)
|
||||
rescue JSON::ParserError => e
|
||||
puts "Failed to load JSON configuration: #{e}\nConfig was: #{config.inspect}"
|
||||
exit 1
|
||||
end
|
||||
|
||||
# get the log level
|
||||
# DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
|
||||
def get_log_level(level)
|
||||
valid = %w{debug info warn error fatal}
|
||||
|
||||
if valid.include?(level)
|
||||
l = level
|
||||
else
|
||||
l = 'info'
|
||||
end
|
||||
|
||||
Logger.const_get(l.upcase)
|
||||
end
|
||||
|
||||
def configure_logger(o)
|
||||
o[:logger] = Logger.new(STDOUT)
|
||||
# output json if we have activated the json formatter
|
||||
if opts['log-format'] == 'json'
|
||||
o[:logger].formatter = Logger::JSONFormatter.new
|
||||
end
|
||||
o[:logger].level = get_log_level(o.log_level)
|
||||
end
|
||||
|
||||
def mark_text(text)
|
||||
"\e[0;32m#{text}\e[0m"
|
||||
end
|
||||
|
||||
def headline(title)
|
||||
puts title
|
||||
title.each_char { print '-' }
|
||||
puts
|
||||
end
|
||||
|
||||
def li(entry)
|
||||
puts " #{mark_text('*')} #{entry}"
|
||||
end
|
||||
end
|
||||
|
||||
class Inspec::InspecCLI < Inspec::BaseCLI # rubocop:disable Metrics/ClassLength
|
||||
class_option :diagnose, type: :boolean,
|
||||
desc: 'Show diagnostics (versions, configurations)'
|
||||
|
|
|
|||
127
lib/utils/base_cli.rb
Normal file
127
lib/utils/base_cli.rb
Normal file
|
|
@ -0,0 +1,127 @@
|
|||
# encoding: utf-8
|
||||
# author: Christoph Hartmann
|
||||
# author: Dominik Richter
|
||||
|
||||
class Inspec::BaseCLI < Thor
|
||||
def self.target_options
|
||||
option :target, aliases: :t, type: :string,
|
||||
desc: 'Simple targeting option using URIs, e.g. ssh://user:pass@host:port'
|
||||
option :backend, aliases: :b, type: :string,
|
||||
desc: 'Choose a backend: local, ssh, winrm, docker.'
|
||||
option :host, type: :string,
|
||||
desc: 'Specify a remote host which is tested.'
|
||||
option :port, aliases: :p, type: :numeric,
|
||||
desc: 'Specify the login port for a remote scan.'
|
||||
option :user, type: :string,
|
||||
desc: 'The login user for a remote scan.'
|
||||
option :password, type: :string,
|
||||
desc: 'Login password for a remote scan, if required.'
|
||||
option :key_files, aliases: :i, type: :array,
|
||||
desc: 'Login key or certificate file for a remote scan.'
|
||||
option :path, type: :string,
|
||||
desc: 'Login path to use when connecting to the target (WinRM).'
|
||||
option :sudo, type: :boolean,
|
||||
desc: 'Run scans with sudo. Only activates on Unix and non-root user.'
|
||||
option :sudo_password, type: :string,
|
||||
desc: 'Specify a sudo password, if it is required.'
|
||||
option :sudo_options, type: :string,
|
||||
desc: 'Additional sudo options for a remote scan.'
|
||||
option :ssl, type: :boolean,
|
||||
desc: 'Use SSL for transport layer encryption (WinRM).'
|
||||
option :self_signed, type: :boolean,
|
||||
desc: 'Allow remote scans with self-signed certificates (WinRM).'
|
||||
option :json_config, type: :string,
|
||||
desc: 'Read configuration from JSON file (`-` reads from stdin).'
|
||||
option :log_level, aliases: :l, type: :string,
|
||||
desc: 'Set the log level: info (default), debug, warn, error'
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# helper method to run tests
|
||||
def run_tests(opts, tests)
|
||||
o = opts.dup
|
||||
o[:logger] = Logger.new(opts['format'] == 'json' ? nil : STDOUT)
|
||||
o[:logger].level = get_log_level(o.log_level)
|
||||
|
||||
runner = Inspec::Runner.new(o)
|
||||
runner.add_tests(tests)
|
||||
exit runner.run
|
||||
rescue RuntimeError => e
|
||||
puts e.message
|
||||
end
|
||||
|
||||
def diagnose
|
||||
return unless opts['diagnose']
|
||||
puts "InSpec version: #{Inspec::VERSION}"
|
||||
puts "Train version: #{Train::VERSION}"
|
||||
puts 'Command line configuration:'
|
||||
pp options
|
||||
puts 'JSON configuration file:'
|
||||
pp options_json
|
||||
puts 'Merged configuration:'
|
||||
pp opts
|
||||
puts
|
||||
end
|
||||
|
||||
def opts
|
||||
# argv overrides json
|
||||
Thor::CoreExt::HashWithIndifferentAccess.new(options_json.merge(options))
|
||||
end
|
||||
|
||||
def options_json
|
||||
conffile = options['json_config']
|
||||
@json ||= conffile ? read_config(conffile) : {}
|
||||
end
|
||||
|
||||
def read_config(file)
|
||||
if file == '-'
|
||||
puts 'WARN: reading JSON config from standard input' if STDIN.tty?
|
||||
config = STDIN.read
|
||||
else
|
||||
config = File.read(file)
|
||||
end
|
||||
|
||||
JSON.load(config)
|
||||
rescue JSON::ParserError => e
|
||||
puts "Failed to load JSON configuration: #{e}\nConfig was: #{config.inspect}"
|
||||
exit 1
|
||||
end
|
||||
|
||||
# get the log level
|
||||
# DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
|
||||
def get_log_level(level)
|
||||
valid = %w{debug info warn error fatal}
|
||||
|
||||
if valid.include?(level)
|
||||
l = level
|
||||
else
|
||||
l = 'info'
|
||||
end
|
||||
|
||||
Logger.const_get(l.upcase)
|
||||
end
|
||||
|
||||
def configure_logger(o)
|
||||
o[:logger] = Logger.new(STDOUT)
|
||||
# output json if we have activated the json formatter
|
||||
if opts['log-format'] == 'json'
|
||||
o[:logger].formatter = Logger::JSONFormatter.new
|
||||
end
|
||||
o[:logger].level = get_log_level(o.log_level)
|
||||
end
|
||||
|
||||
def mark_text(text)
|
||||
"\e[0;32m#{text}\e[0m"
|
||||
end
|
||||
|
||||
def headline(title)
|
||||
puts title
|
||||
title.each_char { print '-' }
|
||||
puts
|
||||
end
|
||||
|
||||
def li(entry)
|
||||
puts " #{mark_text('*')} #{entry}"
|
||||
end
|
||||
end
|
||||
Loading…
Reference in a new issue