train-core 3.7.2 → 3.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 017550b023185b37f89bc36e7e1cc920079543ac11fe6d7788813b5363934ed4
-  data.tar.gz: bbd262ace02d7da95ae1ecce35e1c42514cf7a1fcd83f2ae7725b82b8fa65a3f
+  metadata.gz: 677b8d64465040ada12f33f5c2fe7689b81922b10482ca7c78e0b57e10b5139a
+  data.tar.gz: 8c3f7518f0453329897de457e4ea4e6f24d6262dd77f5731b42b5cd44ea706c5
 SHA512:
-  metadata.gz: e7792c1fa21fb7207d23b1c283dbc0a4c989f0d1593747b5d1954b8e349ab9d5b209d5146f2af7442de1e79c519de152e376d7cf240cd1983440da0ed4ddea17
-  data.tar.gz: 55f506d5dbc20b38f89c5f150ffa69f4d6067a20311c891068ece4ce705ee5af01c6c740ced8fc0e52788cd9ab13c25000d47d2800ab7d023580bf18e1a147a8
+  metadata.gz: 8998652d978144993b1768c71d25d8b06f6501c661e827576ecbb06d3e2d8748296d26d68578d6c451a2a20617c1750a5cb66c096adb020b5bc3c0e2ad6bfb4e
+  data.tar.gz: 68cad9574d5282fea0d90fc00104506d0d33ecfd5e5d6879f33f88109aec9b881d0c9d49748e178c4b8ca05896827425d4bb283bb7d52aedbcc722d2817b6b27

data/lib/train/extras/command_wrapper.rb

@@ -81,6 +81,9 @@ module Train::Extras
       when /sudo: sorry, you must have a tty to run sudo/
         ["Sudo requires a TTY. Please see the README on how to configure "\
           "sudo to allow for non-interactive usage.", :sudo_no_tty]
+      when /sudo: a terminal is required to read the password; either use/
+        ["Sudo cannot prompt for password because there is no terminal. "\
+            "Please provide the sudo password directly", :sudo_missing_terminal]
       else
         [rawerr, nil]
       end

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

@@ -12,7 +12,7 @@ module Train
           @spath = path.gsub(/[<>"|?*]/, "")
         end
 
-        def basename(suffix = nil, sep = '\\')
+        def basename(suffix = nil, sep = "\\")
           super(suffix, sep)
         end
 

data/lib/train/transports/local.rb

@@ -190,8 +190,23 @@ module Train::Transports
           script = "$ProgressPreference='SilentlyContinue';" + cmd
           encoded_script = Base64.strict_encode64(script)
           # TODO: no way to safely implement timeouts here.
-          @pipe.puts(encoded_script)
-          @pipe.flush
+          begin
+            @pipe.puts(encoded_script)
+            @pipe.flush
+          rescue Errno::EPIPE
+            # Retry once if the pipe went away
+            begin
+              # Maybe the pipe went away, but the server didn't? Reset it, to get a clean start.
+              close
+            rescue Errno::EIO
+              # Ignore - server already went away
+            end
+            @pipe = acquire_pipe
+            raise PipeError if @pipe.nil?
+
+            @pipe.puts(encoded_script)
+            @pipe.flush
+          end
           res = OpenStruct.new(JSON.parse(Base64.decode64(@pipe.readline)))
           Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
         end
@@ -216,12 +231,10 @@ module Train::Transports
 
           # PowerShell needs time to create pipe.
           100.times do
-            begin
-              pipe = open("//./pipe/#{pipe_name}", "r+")
-              break
-            rescue
-              sleep 0.1
-            end
+            pipe = open("//./pipe/#{pipe_name}", "r+")
+            break
+          rescue
+            sleep 0.1
           end
 
           pipe

data/lib/train/transports/ssh.rb

@@ -42,12 +42,12 @@ module Train::Transports
     include_options Train::Extras::CommandWrapper
 
     # common target configuration
-    option :host,      required: true
-    option :port,      default: 22, coerce: proc { |u| read_options_from_ssh_config(u, :port) }, required: true
-    option :user,      default: "root", coerce: proc { |u| read_options_from_ssh_config(u, :user) }, required: true
+    option :host, required: true
+    option :ssh_config_file, default: true
+    option :port, default: 22, coerce: proc { |v| read_options_from_ssh_config(v, :port) }, required: true
+    option :user, default: "root", coerce: proc { |v| read_options_from_ssh_config(v, :user) }, required: true
     option :key_files, default: nil
     option :password,  default: nil
-
     # additional ssh options
     option :keepalive, default: true
     option :keepalive_interval, default: 60
@@ -75,6 +75,7 @@ module Train::Transports
 
     # (see Base#connection)
     def connection(state = {}, &block)
+      apply_ssh_config_file(options[:host])
       opts = merge_options(options, state || {})
       validate_options(opts)
       conn_opts = connection_options(opts)
@@ -90,12 +91,36 @@ module Train::Transports
     # Params options [Hash], option_type [String]
     # Return String
     def self.read_options_from_ssh_config(options, option_type)
-      config_options = Net::SSH.configuration_for(options[:host], true)
+      files = options[:ssh_config_file].nil? || options[:ssh_config_file] == true ? Net::SSH::Config.default_files : options[:ssh_config_file]
+      config_options = Net::SSH::Config.for(options[:host], files)
       config_options[option_type]
     end
 
+    def apply_ssh_config_file(host)
+      files = options[:ssh_config_file] == true ? Net::SSH::Config.default_files : options[:ssh_config_file]
+      host_cfg = ssh_config_file_for_host(host, files)
+      host_cfg.each do |key, value|
+        # setting the key_files option to the private keys set in ssh config file
+        if key == :keys && options[:key_files].nil? && !host_cfg[:keys].nil? && options[:password].nil?
+          options[:key_files] = host_cfg[key]
+        elsif options[key].nil?
+          # Precedence is given to the option set by the user manually.
+          # And only assigning value to the option from the ssh config file when it is not set by the user
+          # in the option. When the option has a default value for e.g. option "keepalive_interval" has the "60" as the default
+          # value, then the default value will be used even though the value for "user" is present in the ssh
+          # config file. That is because the precedence is to the options set manually, and currently we don't have
+          # any way to differentiate between the value set by the user or is it the default. This has a future of improvement.
+          options[key] = host_cfg[key]
+        end
+      end
+    end
+
     private
 
+    def ssh_config_file_for_host(host, files)
+      Net::SSH::Config.for(host, files)
+    end
+
     def reusable_connection?(conn_opts)
       return false unless @connection_options
 
@@ -109,14 +134,18 @@ module Train::Transports
       key_files = Array(options[:key_files])
       options[:auth_methods] ||= ["none"]
 
-      unless key_files.empty?
-        options[:auth_methods].push("publickey")
+      # by default auth_methods has a default values [none publickey password keyboard-interactive]
+      # REF: https://github.com/net-ssh/net-ssh/blob/master/lib/net/ssh/authentication/session.rb#L48
+      if key_files.empty?
+        options[:auth_methods].delete("publickey")
+      else
         options[:keys_only] = true if options[:password].nil?
         options[:key_files] = key_files
       end
 
-      unless options[:password].nil?
-        options[:auth_methods].push("password", "keyboard-interactive")
+      if options[:password].nil?
+        options[:auth_methods].delete("password")
+        options[:auth_methods].delete("keyboard-interactive")
       end
 
       if options[:auth_methods] == ["none"]
@@ -131,6 +160,8 @@ module Train::Transports
         end
       end
 
+      options[:auth_methods] = options[:auth_methods].uniq
+
       if options[:pty]
         logger.warn("[SSH] PTY requested: stderr will be merged into stdout")
       end
@@ -186,6 +217,7 @@ module Train::Transports
         bastion_port: opts[:bastion_port],
         non_interactive: opts[:non_interactive],
         append_all_supported_algorithms: opts[:append_all_supported_algorithms],
+        config: options[:ssh_config_file],
         transport_options: opts,
       }
       # disable host key verification. The hash key and value to use

data/lib/train/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 3.8.6
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable