File Manager
Viewing File: cli.rb
# Copyright 2015 Dominik Richter
require "inspec/utils/deprecation/deprecator"
require "inspec/dist"
require "inspec/backend"
require "inspec/dependencies/cache"
require "inspec/utils/json_profile_summary"
module Inspec # TODO: move this somewhere "better"?
autoload :BaseCLI, "inspec/base_cli"
autoload :Deprecation, "inspec/utils/deprecation"
autoload :Exceptions, "inspec/exceptions"
autoload :EnvPrinter, "inspec/env_printer"
autoload :Fetcher, "inspec/fetcher"
autoload :Formatters, "inspec/formatters"
autoload :Globals, "inspec/globals"
autoload :Impact, "inspec/impact"
autoload :Impact, "inspec/impact"
autoload :InputRegistry, "inspec/input_registry"
autoload :Profile, "inspec/profile"
autoload :Reporters, "inspec/reporters"
autoload :Resource, "inspec/resource"
autoload :Rule, "inspec/rule"
autoload :Runner, "inspec/runner"
autoload :Runner, "inspec/runner"
autoload :Shell, "inspec/shell"
autoload :SourceReader, "inspec/source_reader"
autoload :Telemetry, "inspec/utils/telemetry"
autoload :V1, "inspec/plugin/v1"
autoload :V2, "inspec/plugin/v2"
autoload :VERSION, "inspec/version"
end
class Inspec::InspecCLI < Inspec::BaseCLI
class_option :log_level, aliases: :l, type: :string,
desc: "Set the log level: info (default), debug, warn, error"
class_option :log_location, type: :string,
desc: "Location to send diagnostic log messages to. (default: $stdout or Inspec::Log.error)"
class_option :diagnose, type: :boolean,
desc: "Show diagnostics (versions, configurations)"
class_option :color, type: :boolean,
desc: "Use colors in output."
class_option :interactive, type: :boolean,
desc: "Allow or disable user interaction"
class_option :disable_core_plugins, type: :string, banner: "", # Actually a boolean, but this suppresses the creation of a --no-disable...
desc: "Disable loading all plugins that are shipped in the lib/plugins directory of InSpec. Useful in development."
class_option :disable_user_plugins, type: :string, banner: "",
desc: "Disable loading all plugins that the user installed."
class_option :enable_telemetry, type: :boolean,
desc: "Allow or disable telemetry", default: false
require "license_acceptance/cli_flags/thor"
include LicenseAcceptance::CLIFlags::Thor
desc "json PATH", "read all tests in PATH and generate a JSON summary"
option :output, aliases: :o, type: :string,
desc: "Save the created profile to a path"
option :controls, type: :array,
desc: "A list of controls to include. Ignore all other tests."
profile_options
def json(target)
require "json"
o = config
diagnose(o)
o["log_location"] = $stderr
configure_logger(o)
o[:backend] = Inspec::Backend.create(Inspec::Config.mock)
o[:check_mode] = true
o[:vendor_cache] = Inspec::Cache.new(o[:vendor_cache])
profile = Inspec::Profile.for_target(target, o)
dst = o[:output].to_s
# Write JSON
Inspec::Utils::JsonProfileSummary.produce_json(
info: profile.info,
write_path: dst
)
rescue StandardError => e
pretty_handle_exception(e)
end
desc "check PATH", "verify all tests at the specified PATH"
option :format, type: :string
profile_options
def check(path) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
o = config
diagnose(o)
o["log_location"] ||= STDERR if o["format"] == "json"
o["log_level"] ||= "warn"
configure_logger(o)
o[:backend] = Inspec::Backend.create(Inspec::Config.mock)
o[:check_mode] = true
o[:vendor_cache] = Inspec::Cache.new(o[:vendor_cache])
# run check
profile = Inspec::Profile.for_target(path, o)
result = profile.check
if o["format"] == "json"
puts JSON.generate(result)
else
%w{location profile controls timestamp valid}.each do |item|
prepared_string = format("%-12s %s",
"#{item.to_s.capitalize} :",
result[:summary][item.to_sym])
ui.plain_line(prepared_string)
end
puts
if result[:errors].empty? && result[:warnings].empty?
ui.plain_line("No errors or warnings")
else
item_msg = lambda { |item|
pos = [item[:file], item[:line], item[:column]].compact.join(":")
pos.empty? ? item[:msg] : pos + ": " + item[:msg]
}
result[:errors].each { |item| ui.red " #{Inspec::UI::GLYPHS[:script_x]} #{item_msg.call(item)}\n" }
result[:warnings].each { |item| ui.yellow " ! #{item_msg.call(item)}\n" }
puts
errors = ui.red("#{result[:errors].length} errors", print: false)
warnings = ui.yellow("#{result[:warnings].length} warnings", print: false)
ui.plain_line("Summary: #{errors}, #{warnings}")
end
end
ui.exit Inspec::UI::EXIT_USAGE_ERROR unless result[:summary][:valid]
rescue StandardError => e
pretty_handle_exception(e)
end
desc "vendor PATH", "Download all dependencies and generate a lockfile in a `vendor` directory"
option :overwrite, type: :boolean, default: false,
desc: "Overwrite existing vendored dependencies and lockfile."
def vendor(path = nil)
o = config
configure_logger(o)
o[:logger] = Logger.new($stdout)
o[:logger].level = get_log_level(o[:log_level])
vendor_deps(path, o)
end
desc "archive PATH", "archive a profile to tar.gz (default) or zip"
profile_options
option :output, aliases: :o, type: :string,
desc: "Save the archive to a path"
option :zip, type: :boolean, default: false,
desc: "Generates a zip archive."
option :tar, type: :boolean, default: false,
desc: "Generates a tar.gz archive."
option :overwrite, type: :boolean, default: false,
desc: "Overwrite existing archive."
option :airgap, type: :boolean, banner: "",
desc: "Fallback to using local archives if fetching fails."
option :ignore_errors, type: :boolean, default: false,
desc: "Ignore profile warnings."
def archive(path)
o = config
diagnose(o)
o[:logger] = Logger.new($stdout)
o[:logger].level = get_log_level(o[:log_level])
o[:backend] = Inspec::Backend.create(Inspec::Config.mock)
# Force vendoring with overwrite when archiving
vendor_options = o.dup
vendor_options[:overwrite] = true
vendor_deps(path, vendor_options)
profile = Inspec::Profile.for_target(path, o)
result = profile.check
if result && !o[:ignore_errors] == false
o[:logger].info "Profile check failed. Please fix the profile before generating an archive."
return ui.exit Inspec::UI::EXIT_USAGE_ERROR
end
# generate archive
ui.exit Inspec::UI::EXIT_USAGE_ERROR unless profile.archive(o)
rescue StandardError => e
pretty_handle_exception(e)
end
desc "exec LOCATIONS", <<~EOT
Run all test files at the specified LOCATIONS.
Loads the given profile(s) and fetches their dependencies if needed. Then
connects to the target and executes any controls contained in the profiles.
One or more reporters are used to generate output.
```
Exit codes:
0 Normal exit, all tests passed
1 Usage or general error
2 Error in plugin system
3 Fatal deprecation encountered
100 Normal exit, at least one test failed
101 Normal exit, at least one test skipped but none failed
172 Chef License not accepted
```
Below are some examples of using `exec` with different test LOCATIONS:
Automate:
```
#{Inspec::Dist::EXEC_NAME} compliance login
#{Inspec::Dist::EXEC_NAME} exec compliance://username/linux-baseline
```
Supermarket:
```
#{Inspec::Dist::EXEC_NAME} exec supermarket://username/linux-baseline
```
Local profile (executes all tests in `controls/`):
```
#{Inspec::Dist::EXEC_NAME} exec /path/to/profile
```
Local single test (doesn't allow inputs or custom resources)
```
#{Inspec::Dist::EXEC_NAME} exec /path/to/a_test.rb
```
Git via SSH
```
#{Inspec::Dist::EXEC_NAME} exec git@github.com:dev-sec/linux-baseline.git
```
Git via HTTPS (.git suffix is required):
```
#{Inspec::Dist::EXEC_NAME} exec https://github.com/dev-sec/linux-baseline.git
```
Private Git via HTTPS (.git suffix is required):
```
#{Inspec::Dist::EXEC_NAME} exec https://API_TOKEN@github.com/dev-sec/linux-baseline.git
```
Private Git via HTTPS and cached credentials (.git suffix is required):
```
git config credential.helper cache
git ls-remote https://github.com/dev-sec/linux-baseline.git
#{Inspec::Dist::EXEC_NAME} exec https://github.com/dev-sec/linux-baseline.git
```
Web hosted fileshare (also supports .zip):
```
#{Inspec::Dist::EXEC_NAME} exec https://webserver/linux-baseline.tar.gz
```
Web hosted fileshare with basic authentication (supports .zip):
```
#{Inspec::Dist::EXEC_NAME} exec https://username:password@webserver/linux-baseline.tar.gz
```
EOT
exec_options
def exec(*targets)
o = config
diagnose(o)
configure_logger(o)
runner = Inspec::Runner.new(o)
targets.each { |target| runner.add_target(target) }
ui.exit runner.run
rescue ArgumentError, RuntimeError, Train::UserError => e
$stderr.puts e.message
ui.exit Inspec::UI::EXIT_USAGE_ERROR
rescue StandardError => e
pretty_handle_exception(e)
end
desc "detect", "detect the target OS"
target_options
option :format, type: :string
def detect
o = config
o[:command] = "platform.params"
configure_logger(o)
(_, res) = run_command(o)
if o["format"] == "json"
puts res.to_json
else
ui.headline("Platform Details")
ui.plain Inspec::BaseCLI.format_platform_info(params: res, indent: 0, color: 36)
end
rescue ArgumentError, RuntimeError, Train::UserError => e
$stderr.puts e.message
ui.exit Inspec::UI::EXIT_USAGE_ERROR
rescue StandardError => e
pretty_handle_exception(e)
end
desc "shell", "open an interactive debugging shell"
target_options
option :command, aliases: :c,
desc: "A single command string to run instead of launching the shell"
option :reporter, type: :array,
banner: "one two:/output/file/path",
desc: "Enable one or more output reporters: cli, documentation, html, progress, json, json-min, json-rspec, junit"
option :depends, type: :array, default: [],
desc: "A space-delimited list of local folders containing profiles whose libraries and resources will be loaded into the new shell"
option :distinct_exit, type: :boolean, default: true,
desc: "Exit with code 100 if any tests fail, and 101 if any are skipped but none failed (default). If disabled, exit 0 on skips and 1 for failures."
option :inspect, type: :boolean, default: false, desc: "Use verbose/debugging output for resources."
def shell_func
o = config
diagnose(o)
o[:debug_shell] = true
Inspec::Resource.toggle_inspect unless o[:inspect]
log_device = suppress_log_output?(o) ? nil : $stdout
o[:logger] = Logger.new(log_device)
o[:logger].level = get_log_level(o[:log_level])
if o[:command].nil?
runner = Inspec::Runner.new(o)
return Inspec::Shell.new(runner).start
end
run_type, res = run_command(o)
ui.exit res unless run_type == :ruby_eval
# No InSpec tests - just print evaluation output.
reporters = o["reporter"] || {}
if reporters.keys.include?("json")
res = if res.respond_to?(:to_json)
res.to_json
else
JSON.dump(res)
end
end
puts res
ui.exit Inspec::UI::EXIT_NORMAL
rescue RuntimeError, Train::UserError => e
$stderr.puts e.message
rescue StandardError => e
pretty_handle_exception(e)
end
desc "env", "Output shell-appropriate completion configuration"
def env(shell = nil)
p = Inspec::EnvPrinter.new(self.class, shell)
p.print_and_exit!
rescue StandardError => e
pretty_handle_exception(e)
end
desc "schema NAME", "print the JSON schema", hide: true
def schema(name)
require "inspec/schema/output_schema"
puts Inspec::Schema::OutputSchema.json(name)
rescue StandardError => e
puts e
puts "Valid schemas are #{Inspec::Schema::OutputSchema.names.join(", ")}"
end
desc "run_context", "used to test run-context detection", hide: true
def run_context
require "inspec/utils/telemetry/run_context_probe"
puts Inspec::Telemetry::RunContextProbe.guess_run_context
end
desc "version", "prints the version of this tool"
option :format, type: :string
def version
if config["format"] == "json"
v = { version: Inspec::VERSION }
puts v.to_json
else
puts Inspec::VERSION
end
end
map %w{-v --version} => :version
private
def run_command(opts)
runner = Inspec::Runner.new(Inspec::Config.new(opts))
res = runner.eval_with_virtual_profile(opts[:command])
runner.load
return :ruby_eval, res if runner.all_rules.empty?
return :rspec_run, runner.run_tests # rubocop:disable Style/RedundantReturn
end
end
#=====================================================================#
# Pre-Flight Code
#=====================================================================#
help_commands = ["-h", "--help", "help"]
#---------------------------------------------------------------------#
# Adjustments for help handling
# This allows you to use any of the normal help commands after the normal args.
#---------------------------------------------------------------------#
(help_commands & ARGV).each do |cmd|
# move the help argument to one place behind the end for Thor to digest
if ARGV.size > 1
match = ARGV.delete(cmd)
ARGV.insert(-2, match)
end
end
#---------------------------------------------------------------------#
# Plugin Loading
#---------------------------------------------------------------------#
require "inspec/plugin/v2"
begin
# Load v2 plugins. Manually check for plugin disablement.
omit_core = ARGV.delete("--disable-core-plugins")
omit_user = ARGV.delete("--disable-user-plugins")
v2_loader = Inspec::Plugin::V2::Loader.new(omit_core_plugins: omit_core, omit_user_plugins: omit_user)
v2_loader.load_all
v2_loader.exit_on_load_error
v2_loader.activate_mentioned_cli_plugins
# Load v1 plugins on startup
ctl = Inspec::PluginCtl.new
ctl.list.each { |x| ctl.load(x) }
# load v1 CLI plugins before the InSpec CLI has been started
Inspec::Plugins::CLI.subcommands.each do |_subcommand, params|
Inspec::InspecCLI.register(
params[:klass],
params[:subcommand_name],
params[:usage],
params[:description],
params[:options]
)
end
rescue Inspec::Plugin::V2::Exception => v2ex
Inspec::Log.error v2ex.message
if ARGV.include?("--debug")
Inspec::Log.error v2ex.class.name
Inspec::Log.error v2ex.backtrace.join("\n")
else
Inspec::Log.error "Run again with --debug for a stacktrace."
end
exit Inspec::UI::EXIT_PLUGIN_ERROR
end