train-core 3.10.8 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd9123fc8c77d6d2913633bb544aae171f440d3a0558bacda3136fa62d856661
-  data.tar.gz: b8e558c2c7fa1479725228f1745ff5ed610f6975babc43cb07bbfb6289f41806
+  metadata.gz: 0b10470a7175d568ce7d0df7a3497deb7709ad5ca210f542654f3c560585bacb
+  data.tar.gz: 6d91bd6042737e52411a58c30b1c9127bf6a402402e1800abe708ca02434e7ec
 SHA512:
-  metadata.gz: 0ed3576117bf704f08d0170e3f9c9d08e20da634300f02b986aaa8fb18094d0b027d9943bcc04043d986102e641ed7c09a4ed163ca6b9f8de1488d3063043721
-  data.tar.gz: deb114924bc9f537bb8a8c4df1f0b48936c8b7e081539109b886b4c26f994a6f96b214d514d2109ab75b526e2328473fb56f323e0746a28f8cf4cfce4df8e334
+  metadata.gz: 8ce7f3b1b9c3bd621adbdecbb2e11b3815621f97e50ad24567eb70eeaa8b8b5e239e1a6393efec0d732960f3ad9d46072fff176ea40cf6108f6a1f1102bc5685
+  data.tar.gz: ee8265ac08e6c4ed064229cef212471fa3cb52f4be75e478342993a5901b591d545f21ef46cce35c39e734d8e283fe6d26d4f76b6fa98b5c7428649fb83a2c32

data/lib/train/audit_log.rb

@@ -0,0 +1,21 @@
+module Train
+  class AuditLog
+    # Default values for audit log options are set in the options.rb
+    def self.create(options = {})
+      # Load monkey-patch to disable leading comment in logfiles
+      require_relative "logger_ext"
+
+      logger = Logger.new(options[:audit_log_location], options[:audit_log_frequency], options[:audit_log_size])
+      logger.level = options[:level] || Logger::INFO
+      logger.progname = options[:audit_log_app_name]
+      logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+      logger.formatter = proc do |severity, datetime, progname, msg|
+        {
+          timestamp: datetime.to_s,
+          app: progname,
+        }.merge(msg).compact.to_json + $/
+      end
+      logger
+    end
+  end
+end

data/lib/train/logger_ext.rb

@@ -0,0 +1,8 @@
+
+# Part of Audit Log.
+# The default logger implementation injects a comment as the first line of the
+# log file, which makes it an invalid JSON file. No way to disable that other than monkey-patching.
+
+class Logger::LogDevice
+  def add_log_header(file); end
+end

data/lib/train/options.rb

@@ -34,6 +34,18 @@ module Train
         @default_options
       end
 
+      # Created separate method to set the default audit log options so that it will be handled separately
+      # and will not break any existing functionality
+      def default_audit_log_options
+        {
+          enable_audit_log: { default: false },
+          audit_log_location: { required: true, default: nil },
+          audit_log_app_name: { default: "train" },
+          audit_log_size: { default: nil },
+          audit_log_frequency: { default: 0 },
+        }
+      end
+
       def include_options(other)
         unless other.respond_to?(:default_options)
           raise "Trying to include options from module #{other.inspect}, "\
@@ -47,13 +59,18 @@ module Train
       # @return [Hash] options, which created this Transport
       attr_reader :options
 
+      def default_audit_log_options
+        self.class.default_audit_log_options
+      end
+
       def default_options
         self.class.default_options
       end
 
       def merge_options(base, opts)
         res = base.merge(opts || {})
-        default_options.each do |field, hm|
+        # Also merge the default audit log options into the options so that those are available at the time of validation.
+        default_options.merge(default_audit_log_options).each do |field, hm|
           next unless res[field].nil? && hm.key?(:default)
 
           default = hm[:default]
@@ -78,6 +95,18 @@ module Train
         end
         opts
       end
+
+      # Introduced this method to validate only audit log options and avoiding call to validate_options so
+      # that it will no break existing implementation.
+      def validate_audit_log_options(opts)
+        default_audit_log_options.each do |field, hm|
+          if opts[field].nil? && hm[:required]
+            raise Train::ClientError,
+              "You must provide a value for #{field.to_s.inspect}."
+          end
+        end
+        opts
+      end
     end
   end
 end

data/lib/train/plugins/base_connection.rb

@@ -3,6 +3,7 @@ require_relative "../extras"
 require_relative "../file"
 require "fileutils" unless defined?(FileUtils)
 require "logger"
+require_relative "../audit_log"
 
 class Train::Plugins::Transport
   # A Connection instance can be generated and re-generated, given new
@@ -20,10 +21,21 @@ class Train::Plugins::Transport
     # @yield [self] yields itself for block-style invocation
     def initialize(options = nil)
       @options = options || {}
+
       @logger = @options.delete(:logger) || Logger.new($stdout, level: :fatal)
       Train::Platforms::Detect::Specifications::OS.load
       Train::Platforms::Detect::Specifications::Api.load
 
+      # In run_command all options are not accessible as some of them gets deleted in transit.
+      # To make the data like hostname, username available to aduit logs dup the options
+      @audit_log_data = options.dup || {}
+      # For transport other than local all audit log options accessible inside transport_options key
+      if !@options.empty? && @options[:transport_options] && @options[:transport_options][:enable_audit_log]
+        @audit_log = Train::AuditLog.create(options[:transport_options])
+      elsif !@options.empty? && @options[:enable_audit_log]
+        @audit_log = Train::AuditLog.create(@options)
+      end
+
       # default caching options
       @cache_enabled = {
         file: true,
@@ -140,11 +152,14 @@ class Train::Plugins::Transport
       # Some implementations do not accept an opts argument.
       # We cannot update all implementations to accept opts due to them being separate plugins.
       # Therefore here we check the implementation's arity to maintain compatibility.
+      @audit_log.info({ type: "cmd", command: "#{cmd}", user: @audit_log_data[:username], hostname: @audit_log_data[:hostname] }) if @audit_log
+
       case method(:run_command_via_connection).arity.abs
       when 1
         return run_command_via_connection(cmd, &data_handler) unless cache_enabled?(:command)
 
         @cache[:command][cmd] ||= run_command_via_connection(cmd, &data_handler)
+
       when 2
         return run_command_via_connection(cmd, opts, &data_handler) unless cache_enabled?(:command)
 
@@ -157,29 +172,31 @@ class Train::Plugins::Transport
     # This is the main file call for all connections. This will call the private
     # file_via_connection on the connection with optional caching
     def file(path, *args)
+      @audit_log.info({ type: "file", path: "#{path}", user: @audit_log_data[:username], hostname: @audit_log_data[:hostname] }) if @audit_log
       return file_via_connection(path, *args) unless cache_enabled?(:file)
 
       @cache[:file][path] ||= file_via_connection(path, *args)
     end
 
-    # Uploads local files or directories to remote host.
+    # Uploads local files to remote host.
     #
-    # @param locals [Array<String>] paths to local files or directories
+    # @param locals [String, Array<String>] path to local files
     # @param remote [String] path to remote destination
     # @raise [TransportFailed] if the files could not all be uploaded
     #   successfully, which may vary by implementation
     def upload(locals, remote)
-      unless file(remote).directory?
-        raise TransportError, "#{self.class} expects remote directory as second upload parameter"
+      remote_directory = file(remote).directory?
+
+      if locals.is_a?(Array) && !remote_directory
+        raise Train::TransportError, "#{self.class} expects remote directory as second upload parameter for multi-file uploads"
       end
 
       Array(locals).each do |local|
-        new_content = File.read(local)
-        remote_file = File.join(remote, File.basename(local))
-
+        remote_file = remote_directory ? File.join(remote, File.basename(local)) : remote
+        @audit_log.info({ type: "file upload", source: local, destination: remote_file, user: @audit_log_data[:username], hostname: @audit_log_data[:hostname] }) if @audit_log
         logger.debug("Attempting to upload '#{local}' as file #{remote_file}")
 
-        file(remote_file).content = new_content
+        file(remote_file).content = File.read(local)
       end
     end
 
@@ -197,7 +214,6 @@ class Train::Plugins::Transport
       Array(remotes).each do |remote|
         new_content = file(remote).content
         local_file = File.join(local, File.basename(remote))
-
         logger.debug("Attempting to download '#{remote}' as file #{local_file}")
 
         File.open(local_file, "w") { |fp| fp.write(new_content) }

data/lib/train/plugins/transport.rb

@@ -21,6 +21,12 @@ class Train::Plugins
     def initialize(options = {})
       @options = merge_options({}, options || {})
       @logger = @options[:logger] || Logger.new($stdout, level: :fatal)
+      # Validates audit log configuration options if audit log is enabled
+      # The reason to implement different validate method for audit log options is
+      # to validate only audit log options and not to break any existing validate_option implementation.
+      if !@options.empty? && @options[:enable_audit_log]
+        validate_audit_log_options(options)
+      end
     end
 
     # Create a connection to the target. Options may be provided

data/lib/train/version.rb

@@ -2,5 +2,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = "3.10.8".freeze
+  VERSION = "3.11.0".freeze
 end

data/lib/train.rb

@@ -26,7 +26,8 @@ module Train
   # @return [Hash] map of default options
   def self.options(name)
     cls = load_transport(name)
-    cls.default_options unless cls.nil?
+    # Merging default_audit_log_options so that they will get listed in the options that are available.
+    cls.default_options.merge(cls.default_audit_log_options) unless cls.nil?
   end
 
   # Load the transport plugin indicated by name. If the plugin is not

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.10.8
+  version: 3.11.0
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -127,6 +127,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - lib/train.rb
+- lib/train/audit_log.rb
 - lib/train/errors.rb
 - lib/train/extras.rb
 - lib/train/extras/command_wrapper.rb
@@ -142,6 +143,7 @@ files:
 - lib/train/file/remote/unix.rb
 - lib/train/file/remote/windows.rb
 - lib/train/globals.rb
+- lib/train/logger_ext.rb
 - lib/train/options.rb
 - lib/train/platforms.rb
 - lib/train/platforms/common.rb