train-core 3.4.1 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcdd1ac651c1272f119e63d0edb3d9267b4811088a0e3133b90d1fa969c79258
-  data.tar.gz: '09c95e4d2627b99f5c878336f84f416fd61ee46225362973b81ad0d4b70559a2'
+  metadata.gz: 4debe973595fd78f3fc61e3ebb8d62061d5d6a72f72077ae972422a24c8fa403
+  data.tar.gz: 9696bd7bc5ad5de2cbaa1fef3b8cf38deb34ebb4a78b61fe85acf648559d50c4
 SHA512:
-  metadata.gz: f0bec9907895f76f5e211fafdc1e1adc5ea7603a5db7c6e3ac4e098102976aa13c0ca2e2c2fa4eb8d67666820e516336a063a32687a4ba22683cdec8fc7a4584
-  data.tar.gz: 3c2444b2309bccff9f61f52a0c235b090e7d3040a01ec084da895a287a600708278b934e84a9f268c30fa2e306035cd3eeb6621fd201cd7492f5af5560b04a13
+  metadata.gz: a4edf4fadbfe0f9e9ee8febd26bfa806d953129ed06e1c892acde68ffa3fcb0820bef51f5eeacf31f61ba83e3ed0084cec5ed2cc34911974338a20e1b3c0c580
+  data.tar.gz: e37d56303596018a0185b569c85fe72a38a00d0d99ee597f9cd42012142eb33eb0483c74e7d17fd1141c77982e7346507ad4f1d0c7fd31614fc84b66803ad99a

data/lib/train/file/local.rb

@@ -15,6 +15,12 @@ module Train
         nil
       end
 
+      def content=(new_content)
+        ::File.open(@path, "w", encoding: "UTF-8") { |fp| fp.write(new_content) }
+
+        @content = new_content
+      end
+
       def link_path
         return nil unless symlink?
 

data/lib/train/file/remote/unix.rb

@@ -1,3 +1,4 @@
+require "base64" unless defined?(Base64)
 require "shellwords" unless defined?(Shellwords)
 
 module Train
@@ -19,6 +20,21 @@ module Train
             end
         end
 
+        def content=(new_content)
+          execute_result = @backend.run_command("base64 --help")
+          if execute_result.exit_status != 0
+            raise TransportError, "#{self.class} found no base64 binary for file writes"
+          end
+
+          unix_cmd = format("echo '%<base64>s' | base64 --decode > %<file>s",
+                            base64: Base64.strict_encode64(new_content),
+                            file: @spath)
+
+          @backend.run_command(unix_cmd)
+
+          @content = new_content
+        end
+
         def exist?
           @exist ||= begin
             f = @follow_symlink ? "" : " || test -L #{@spath}"

data/lib/train/file/remote/windows.rb

@@ -26,6 +26,16 @@ module Train
           @content
         end
 
+        def content=(new_content)
+          win_cmd = format('[IO.File]::WriteAllBytes("%<file>s", [Convert]::FromBase64String("%<base64>s"))',
+                           base64: Base64.strict_encode64(new_content),
+                           file: @spath)
+
+          @backend.run_command(win_cmd)
+
+          @content = new_content
+        end
+
         def exist?
           return @exist if defined?(@exist)
 

data/lib/train/plugins/base_connection.rb

@@ -1,6 +1,7 @@
 require_relative "../errors"
 require_relative "../extras"
 require_relative "../file"
+require "fileutils" unless defined?(FileUtils)
 require "logger"
 
 class Train::Plugins::Transport
@@ -161,6 +162,48 @@ class Train::Plugins::Transport
       @cache[:file][path] ||= file_via_connection(path, *args)
     end
 
+    # Uploads local files or directories to remote host.
+    #
+    # @param locals [Array<String>] paths to local files or directories
+    # @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"
+      end
+
+      Array(locals).each do |local|
+        new_content = File.read(local)
+        remote_file = File.join(remote, File.basename(local))
+
+        logger.debug("Attempting to upload '#{local}' as file #{remote_file}")
+
+        file(remote_file).content = new_content
+      end
+    end
+
+    # Download remote files or directories to local host.
+    #
+    # @param remotes [Array<String>] paths to remote files or directories
+    # @param local [String] path to local destination. If `local` is an
+    #   existing directory, `remote` will be downloaded into the directory
+    #   using its original name
+    # @raise [TransportFailed] if the files could not all be downloaded
+    #   successfully, which may vary by implementation
+    def download(remotes, local)
+      FileUtils.mkdir_p(File.dirname(local))
+
+      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) }
+      end
+    end
+
     # Builds a LoginCommand which can be used to open an interactive
     # session on the remote host.
     #

data/lib/train/transports/cisco_ios_connection.rb

@@ -29,6 +29,14 @@ class Train::Transports::SSH
       result.stdout.split(" ")[-1]
     end
 
+    def upload(locals, remote)
+      raise NotImplementedError, "#{self.class} does not implement #upload()"
+    end
+
+    def download(remotes, local)
+      raise NotImplementedError, "#{self.class} does not implement #download()"
+    end
+
     private
 
     def establish_connection

data/lib/train/transports/local.rb

@@ -31,10 +31,26 @@ module Train::Transports
         nil # none, open your shell
       end
 
+      def close
+        @runner.close
+      end
+
       def uri
         "local://"
       end
 
+      def upload(locals, remote)
+        FileUtils.mkdir_p(remote)
+
+        Array(locals).each do |local|
+          FileUtils.cp_r(local, remote)
+        end
+      end
+
+      def download(remotes, local)
+        upload(remotes, local)
+      end
+
       private
 
       def select_runner(options)
@@ -108,6 +124,10 @@ module Train::Transports
           res.run_command
           Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
         end
+
+        def close
+          # nothing to do at the moment
+        end
       end
 
       class WindowsShellRunner
@@ -132,6 +152,10 @@ module Train::Transports
           res.run_command
           Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
         end
+
+        def close
+          # nothing to do at the moment
+        end
       end
 
       class WindowsPipeRunner
@@ -141,6 +165,7 @@ module Train::Transports
 
         def initialize(powershell_cmd = "powershell")
           @powershell_cmd = powershell_cmd
+          @server_pid = nil
           @pipe = acquire_pipe
           raise PipeError if @pipe.nil?
         end
@@ -160,12 +185,21 @@ module Train::Transports
           Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
         end
 
+        def close
+          Process.kill("KILL", @server_pid) unless @server_pid.nil?
+          @server_pid = nil
+        end
+
         private
 
         def acquire_pipe
+          require "win32/process"
           pipe_name = "inspec_#{SecureRandom.hex}"
 
-          start_pipe_server(pipe_name)
+          @server_pid = start_pipe_server(pipe_name)
+
+          # Ensure process is killed when the Train process exits
+          at_exit { close rescue Errno::EIO }
 
           pipe = nil
 
@@ -227,11 +261,7 @@ module Train::Transports
           utf8_script = script.encode("UTF-16LE", "UTF-8")
           base64_script = Base64.strict_encode64(utf8_script)
           cmd = "#{@powershell_cmd} -NoProfile -ExecutionPolicy bypass -NonInteractive -EncodedCommand #{base64_script}"
-
-          server_pid = Process.create(command_line: cmd).process_id
-
-          # Ensure process is killed when the Train process exits
-          at_exit { Process.kill("KILL", server_pid) }
+          Process.create(command_line: cmd).process_id
         end
       end
     end

data/lib/train/transports/ssh_connection.rb

@@ -29,8 +29,8 @@ class Train::Transports::SSH
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class Connection < BaseConnection # rubocop:disable Metrics/ClassLength
-    attr_reader :hostname
-    attr_reader :transport_options
+    attr_reader   :hostname
+    attr_accessor :transport_options
 
     def initialize(options)
       # Track IOS command retries to prevent infinite loop on IOError. This must
@@ -72,13 +72,18 @@ class Train::Transports::SSH
 
       args  = %w{ -o UserKnownHostsFile=/dev/null }
       args += %w{ -o StrictHostKeyChecking=no }
-      args += %w{ -o IdentitiesOnly=yes }        if options[:keys]
-      args += %w{ -o BatchMode=yes }             if options[:non_interactive]
+      args += %w{ -o BatchMode=yes } if options[:non_interactive]
       args += %W{ -o LogLevel=#{level} }
       args += %W{ -o ForwardAgent=#{fwd_agent} } if options.key?(:forward_agent)
-      Array(options[:keys]).each do |ssh_key|
-        args += %W{ -i #{ssh_key} }
+
+      keys = Array(options[:keys])
+      unless keys.empty?
+        args += %w{ -o IdentitiesOnly=yes }
+        keys.each do |ssh_key|
+          args += %W{ -i #{ssh_key} }
+        end
       end
+
       args
     end
 
@@ -242,6 +247,16 @@ class Train::Transports::SSH
 
       exit_status, stdout, stderr = execute_on_channel(cmd, opts, &data_handler)
 
+      # An interactive console might contain the STDERR in STDOUT
+      # concat both outputs for non-zero exit status. 
+      output = "#{stdout} #{stderr}".strip if exit_status != 0
+
+      # Abstract the su - USER authentication failure
+      # raise the Train::UserError and passes message & reason
+      if output && output.match?("su: Authentication failure")
+        raise Train::UserError.new(output, :bad_su_user_password)
+      end
+
       # Since `@session.loop` succeeded, reset the IOS command retry counter
       @ios_cmd_retries = 0
 
@@ -317,12 +332,12 @@ class Train::Transports::SSH
         channel.exec(cmd) do |_, success|
           abort "Couldn't execute command on SSH." unless success
           channel.on_data do |_, data|
-            yield(data) if block_given?
+            yield(data, channel) if block_given?
             stdout += data
           end
 
           channel.on_extended_data do |_, _type, data|
-            yield(data) if block_given?
+            yield(data, channel) if block_given?
             stderr += data
           end
 

data/lib/train/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.2
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Transport interface to talk to a selected set of backends.