train-core 3.7.4 → 3.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ccf18cbe443b73ae4ddf1d26acd7bd86730482130481d2d1ab4110311829cba
-  data.tar.gz: 4e377e9a24cfe32eefa8b4a09a5c54a65f1acf8d1d120eb76e4170e45238dc3f
+  metadata.gz: 0e3153fa7d5928d42936093a793c001b1c0988a10c320edba2b887f63a1ec4ab
+  data.tar.gz: 3da18aa2c5e772b2881a670c23074c1775d1d560a87576fdd15d885e4e954c79
 SHA512:
-  metadata.gz: 23bec0bbce7a152996c8c881211fc46908637720f768c3e1254b44409b7da2091984806165d6545e08354b2291d7652f9c1db0b9f930e6a6998a0e5506553d48
-  data.tar.gz: 0eb390214488b1b6ae193235b4c9addc1c3750349b8e5ec59c8314dc5a746ab9533d47b8774bb872baabd339768dd1f0e8b6c7c84edb1fbb7a95b2cadf2a71ba
+  metadata.gz: c64082d00fb778a8326543df95888d03c98a4223a54dfc2073087c7dcef695ca9ca9d8e2c40f5980a9d726431b431283e5a205ba2cdbe1ec2c9a38ce8966be0b
+  data.tar.gz: b10c8793c74e7ae271eaae49e94a7222c1b347ad808d3a16b68f23564c03a6fec5baea0bf8209a99330f3dfcfc76a61a5ef1b1b5df8ff403d995c1fda37f7536

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/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.4".freeze
+  VERSION = "3.8.7".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.7.4
+  version: 3.8.7
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable