inspec 4.18.51 → 4.18.85

data/lib/inspec.rb

@@ -1,30 +0,0 @@
-# copyright: 2015, Dominik Richter
-
-libdir = File.dirname(__FILE__)
-$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
-
-require "inspec/version"
-require "inspec/exceptions"
-require "inspec/utils/deprecation"
-require "inspec/profile"
-require "inspec/rule"
-require "matchers/matchers"
-require "inspec/runner"
-require "inspec/shell"
-require "inspec/formatters"
-require "inspec/reporters"
-require "inspec/input_registry"
-require "inspec/rspec_extensions"
-require "inspec/globals"
-require "inspec/impact"
-require "inspec/utils/telemetry"
-require "inspec/utils/telemetry/global_methods"
-
-require "inspec/plugin/v2"
-require "inspec/plugin/v1"
-
-# all utils that may be required by legacy plugins
-require "inspec/base_cli"
-require "inspec/fetcher"
-require "inspec/source_reader"
-require "inspec/resource"

data/lib/inspec/archive/tar.rb

@@ -1,25 +0,0 @@
-require "rubygems/package"
-
-module Inspec::Archive
-  class TarArchiveGenerator
-    def archive(base_dir, files, archive)
-      File.open(archive, "wb") do |file|
-        Zlib::GzipWriter.wrap(file) do |gz|
-          Gem::Package::TarWriter.new(gz) do |tar|
-            files.each do |input_filename|
-              path = Pathname.new(base_dir).join(input_filename)
-              stat = File.stat(path)
-              if path.directory?
-                tar.mkdir(input_filename, stat.mode)
-              else
-                tar.add_file_simple(input_filename, stat.mode, stat.size) do |io|
-                  io.write(File.binread(path))
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/inspec/archive/zip.rb

@@ -1,15 +0,0 @@
-require "rubygems"
-require "zip"
-require "pathname"
-
-module Inspec::Archive
-  class ZipArchiveGenerator
-    def archive(base_dir, files, archive)
-      Zip::File.open(archive, Zip::File::CREATE) do |zipfile|
-        files.each do |input_filename|
-          zipfile.add(input_filename, Pathname.new(base_dir).join(input_filename))
-        end
-      end
-    end
-  end
-end

data/lib/inspec/backend.rb

@@ -1,101 +0,0 @@
-# copyright: 2015, Dominik Richter
-
-require "train"
-require "inspec/config"
-require "inspec/version"
-require "inspec/resource"
-require "inspec/dsl" # for method_missing_resource
-
-module Inspec
-  module Backend
-    module Base
-      attr_accessor :profile
-
-      # Provide a shorthand to retrieve the inspec version from within a profile
-      #
-      # @return [String] inspec version
-      def version
-        Inspec::VERSION
-      end
-
-      # Determine whether the connection/transport is a local connection
-      # Useful for resources to modify behavior as necessary, such as using
-      # the Ruby stdlib for a better experience.
-      def local_transport?
-        return false unless defined?(Train::Transports::Local)
-
-        backend.is_a?(Train::Transports::Local::Connection)
-      end
-
-      # Ruby internal for printing a nice name for this class
-      def to_s
-        "Inspec::Backend::Class"
-      end
-
-      # Ruby internal for pretty-printing a summary for this class
-      def inspect
-        "Inspec::Backend::Class @transport=#{backend.class}"
-      end
-    end
-
-    # Create the transport backend with aggregated resources.
-    #
-    # @param [Inspec::Config] config for the transport backend
-    # @return [TransportBackend] enriched transport instance
-    def self.create(config) # rubocop:disable Metrics/AbcSize
-      train_credentials = config.unpack_train_credentials
-      transport_name = Train.validate_backend(train_credentials)
-      transport = Train.create(transport_name, train_credentials)
-      if transport.nil?
-        raise "Can't find transport backend '#{transport_name}'."
-      end
-
-      connection = transport.connection
-      if connection.nil?
-        raise "Can't connect to transport backend '#{transport_name}'."
-      end
-
-      # Set caching settings. We always want to enable caching for
-      # the Mock transport for testing.
-      if config[:backend_cache] || config[:backend] == :mock
-        Inspec::Log.debug "Option backend_cache is enabled"
-        connection.enable_cache(:file)
-        connection.enable_cache(:command)
-      elsif config[:debug_shell]
-        Inspec::Log.debug "Option backend_cache is disabled"
-        connection.disable_cache(:file)
-        connection.disable_cache(:command)
-      else
-        Inspec::Log.debug "Option backend_cache is disabled"
-        connection.disable_cache(:file)
-        connection.disable_cache(:command)
-      end
-
-      cls = Class.new do
-        include Base
-
-        define_method :backend do
-          connection
-        end
-
-        def method_missing(id, *args, &blk)
-          Inspec::DSL.method_missing_resource(self, id, *args)
-        rescue LoadError
-          super
-        end
-
-        Inspec::Resource.registry.each do |id, r|
-          define_method id.to_sym do |*args|
-            r.new(self, id.to_s, *args)
-          end
-        end
-      end
-
-      cls.new
-    rescue Train::ClientError => e
-      raise "Client error, can't connect to '#{transport_name}' backend: #{e.message}"
-    rescue Train::TransportError => e
-      raise "Transport error, can't connect to '#{transport_name}' backend: #{e.message}"
-    end
-  end
-end

data/lib/inspec/base_cli.rb

@@ -1,318 +0,0 @@
-require "thor"
-require "inspec/log"
-require "inspec/ui"
-require "inspec/config"
-require "inspec/dist"
-require "inspec/utils/deprecation/global_method"
-
-# Allow end of options during array type parsing
-# https://github.com/erikhuda/thor/issues/631
-class Thor::Arguments
-  alias old_parse_array parse_array
-
-  def parse_array(_name)
-    return shift if peek.is_a?(Array)
-
-    array = []
-    while current_is_value?
-      break unless @parsing_options
-
-      array << shift
-    end
-    array
-  end
-end
-
-module Inspec
-  class BaseCLI < Thor
-    class << self
-      attr_accessor :inspec_cli_command
-    end
-
-    def self.start(given_args = ARGV, config = {})
-      check_license! if config[:enforce_license] || config[:enforce_license].nil?
-
-      super(given_args, config)
-    end
-
-    # EULA acceptance
-    def self.check_license!
-      allowed_commands = ["-h", "--help", "help", "-v", "--version", "version"]
-
-      require "license_acceptance/acceptor"
-      begin
-        if (allowed_commands & ARGV.map(&:downcase)).empty? && # Did they use a non-exempt command?
-            !ARGV.empty? # Did they supply at least one command?
-          LicenseAcceptance::Acceptor.check_and_persist(
-            Inspec::Dist::EXEC_NAME,
-            Inspec::VERSION,
-            logger: Inspec::Log
-          )
-        end
-      rescue LicenseAcceptance::LicenseNotAcceptedError
-        Inspec::Log.error "#{Inspec::Dist::PRODUCT_NAME} cannot execute without accepting the license"
-        Inspec::UI.new.exit(:license_not_accepted)
-      end
-    end
-
-    # https://github.com/erikhuda/thor/issues/244
-    def self.exit_on_failure?
-      true
-    end
-
-    def self.target_options # rubocop:disable MethodLength
-      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, lazy_default: -1,
-        desc: "Login password for a remote scan, if required."
-      option :enable_password, type: :string, lazy_default: -1,
-        desc: "Password for enable mode on Cisco IOS devices."
-      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, lazy_default: -1,
-        desc: "Specify a sudo password, if it is required."
-      option :sudo_options, type: :string,
-        desc: "Additional sudo options for a remote scan."
-      option :sudo_command, type: :string,
-        desc: "Alternate command for sudo."
-      option :shell, type: :boolean,
-        desc: "Run scans in a subshell. Only activates on Unix."
-      option :shell_options, type: :string,
-        desc: "Additional shell options."
-      option :shell_command, type: :string,
-        desc: "Specify a particular shell to use."
-      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 :winrm_transport, type: :string, default: "negotiate",
-        desc: "Specify which transport to use, defaults to negotiate (WinRM)."
-      option :winrm_disable_sspi, type: :boolean,
-        desc: "Whether to use disable sspi authentication, defaults to false (WinRM)."
-      option :winrm_basic_auth, type: :boolean,
-        desc: "Whether to use basic authentication, defaults to false (WinRM)."
-      option :config, type: :string,
-        desc: "Read configuration from JSON file (`-` reads from stdin)."
-      option :json_config, type: :string, hide: true
-      option :proxy_command, type: :string,
-        desc: "Specifies the command to use to connect to the server"
-      option :bastion_host, type: :string,
-        desc: "Specifies the bastion host if applicable"
-      option :bastion_user, type: :string,
-        desc: "Specifies the bastion user if applicable"
-      option :bastion_port, type: :string,
-        desc: "Specifies the bastion port if applicable"
-      option :insecure, type: :boolean, default: false,
-        desc: "Disable SSL verification on select targets"
-      option :target_id, type: :string,
-        desc: "Provide a ID which will be included on reports"
-    end
-
-    def self.profile_options
-      option :profiles_path, type: :string,
-        desc: "Folder which contains referenced profiles."
-      option :vendor_cache, type: :string,
-        desc: "Use the given path for caching dependencies. (default: ~/.inspec/cache)"
-    end
-
-    def self.exec_options
-      target_options
-      profile_options
-      option :controls, type: :array,
-        desc: "A list of control names to run, or a list of /regexes/ to match against control names. Ignore all other tests."
-      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, yaml"
-      option :input, type: :array, banner: "name1=value1 name2=value2",
-        desc: "Specify one or more inputs directly on the command line, as --input NAME=VALUE"
-      option :input_file, type: :array,
-        desc: "Load one or more input files, a YAML file with values for the profile to use"
-      option :waiver_file, type: :array,
-        desc: "Load one or more waiver files."
-      option :attrs, type: :array,
-        desc: "Legacy name for --input-file - deprecated."
-      option :create_lockfile, type: :boolean,
-        desc: "Write out a lockfile based on this execution (unless one already exists)"
-      option :backend_cache, type: :boolean,
-        desc: "Allow caching for backend command output. (default: true)"
-      option :show_progress, type: :boolean,
-        desc: "Show progress while executing tests."
-      option :distinct_exit, type: :boolean, default: true,
-        desc: "Exit with code 101 if any tests fail, and 100 if any are skipped (default).  If disabled, exit 0 on skips and 1 for failures."
-    end
-
-    def self.format_platform_info(params: {}, indent: 0, color: 39)
-      str = ""
-      params.each do |item, info|
-        data = info
-
-        # Format Array for better output if applicable
-        data = data.join(", ") if data.is_a?(Array)
-
-        # Do not output fields of data is missing ('unknown' is fine)
-        next if data.nil?
-
-        data = "\e[1m\e[#{color}m#{data}\e[0m"
-        str << format("#{" " * indent}%-10s %s\n", item.to_s.capitalize + ":", data)
-      end
-      str
-    end
-
-    # These need to be public methods on any BaseCLI instance,
-    # but Thor interprets all methods as subcommands.  The no_commands block
-    # treats them as regular methods.
-    no_commands do
-      def ui
-        return @ui if defined?(@ui)
-
-        # Make a new UI object, respecting context
-        if options[:color].nil?
-          enable_color = true # If the command does not support the color option, default to on
-        else
-          enable_color = options[:color]
-        end
-
-        # UI will probe for TTY if nil - just send the raw option value
-        enable_interactivity = options[:interactive]
-
-        @ui = Inspec::UI.new(color: enable_color, interactive: enable_interactivity)
-      end
-
-      # Rationale: converting this to attr_writer breaks Thor
-      def ui=(new_ui) # rubocop: disable Style/TrivialAccessors
-        @ui = new_ui
-      end
-
-      def mark_text(text)
-        Inspec.deprecate(:inspec_ui_methods)
-        # Note that this one doesn't automatically print
-        ui.emphasis(text, print: false)
-      end
-
-      def headline(title)
-        Inspec.deprecate(:inspec_ui_methods)
-        ui.headline(title)
-      end
-
-      def li(entry)
-        Inspec.deprecate(:inspec_ui_methods)
-        ui.list_item(entry)
-      end
-
-      def plain_text(msg)
-        Inspec.deprecate(:inspec_ui_methods)
-        ui.plain(msg + "\n")
-      end
-
-      def exit(code)
-        Inspec.deprecate(:inspec_ui_methods)
-        ui.exit code
-      end
-    end
-
-    private
-
-    ALL_OF_OUR_REPORTERS = %w{json json-min json-rspec json-automate junit html yaml documentation progress}.freeze # BUT WHY?!?!
-
-    def suppress_log_output?(opts)
-      return false if opts["reporter"].nil?
-
-      match = ALL_OF_OUR_REPORTERS & opts["reporter"].keys
-
-      unless match.empty?
-        match.each do |m|
-          # check to see if we are outputting to stdout
-          return true if opts["reporter"][m]["stdout"] == true
-        end
-      end
-
-      false
-    end
-
-    def diagnose(_ = nil)
-      config.diagnose
-    end
-
-    def config
-      @config ||= Inspec::Config.new(options) # 'options' here is CLI opts from Thor
-    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 pretty_handle_exception(exception)
-      case exception
-      when Inspec::Error
-        $stderr.puts exception.message
-        exit(1)
-      else
-        raise exception
-      end
-    end
-
-    def vendor_deps(path, opts)
-      require "inspec/profile_vendor"
-
-      profile_path = path || Dir.pwd
-      profile_vendor = Inspec::ProfileVendor.new(profile_path)
-
-      if (profile_vendor.cache_path.exist? || profile_vendor.lockfile.exist?) && !opts[:overwrite]
-        puts "Profile is already vendored. Use --overwrite."
-        return false
-      end
-
-      profile_vendor.vendor!
-      puts "Dependencies for profile #{profile_path} successfully vendored to #{profile_vendor.cache_path}"
-    rescue StandardError => e
-      pretty_handle_exception(e)
-    end
-
-    def configure_logger(o)
-      #
-      # TODO(ssd): This is a bit gross, but this configures the
-      # logging singleton Inspec::Log. Eventually it would be nice to
-      # move internal debug logging to use this logging singleton.
-      #
-      loc = if o["log_location"]
-              o["log_location"]
-            elsif suppress_log_output?(o)
-              $stderr
-            else
-              $stdout
-            end
-
-      Inspec::Log.init(loc)
-      Inspec::Log.level = get_log_level(o["log_level"])
-
-      o[:logger] = Logger.new(loc)
-      # output json if we have activated the json formatter
-      if o["log-format"] == "json"
-        o[:logger].formatter = Logger::JSONFormatter.new
-      end
-      o[:logger].level = get_log_level(o["log_level"])
-    end
-  end
-end