train-core 3.8.1 → 3.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acaccd8e644f55898c93991140f7e5b2d80bc097f35a0abd0daffcae9c183d22
-  data.tar.gz: bc1fe10109c88984eaeecb33a8674bac49ccef138c198ffd0fad48f3cf82d3f1
+  metadata.gz: 4f18f7c68501c5b726aa917009507d012e8c31022bedb829a2b4c90636137cb9
+  data.tar.gz: 939cc8932cf9b94c88785e5d3efd0c3e8b3ef0b47948e2f80fe5c7baa434d40d
 SHA512:
-  metadata.gz: 1b4531fa4c4422fa17bafd72591d1215a116c7ba2e0884d5f55f1064f436f1e7c28044983614e7d03a8ef034c7c986357300de77b9303dd50589aefd1ce84588
-  data.tar.gz: f5ef700b4ab4aa297e62cf3f104e9f29fab45d75582d670ae8a9d18bccef602e0aba502b9c2e7f6dc004e13ff240bbc88a0b7f34ae96390c07ef74713e590d6e
+  metadata.gz: 00176b461c853b0d1167451fa43aea79159b696a3e0be0a0cd8a10934ee426d60b6fc463e0cd62643a7c53a6ead8100ec423ab8c1f18c3f48a3085601abf93fc
+  data.tar.gz: ccacf527642f27d7a84782050f0c05f2f0e617ea82b3bac2f5be258a17a2572cdbc0b7212e1eafba48003204012cb616e29daf88649e9349d7b726f59576df41

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: false
+    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)
@@ -86,16 +87,39 @@ module Train::Transports
       end
     end
 
-    # Returns the ssh config option like user, port from config files
-    # 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)
-      config_options[option_type]
+      if options[:ssh_config_file] != false && !options[:ssh_config_file].nil?
+        files = 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
+    end
+
+    def apply_ssh_config_file(host)
+      if options[:ssh_config_file] != false && !options[:ssh_config_file].nil?
+        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?
+            # Give precedence to config file when ssh_config_file options is set to true or to the path of the config file.
+            # This is required as there are default values set for some of the opitons and we unable to
+            # identify whether the values are set from the cli option or those are default so either we should give
+            # precedence to config file or otherwise we need to check each options default values and then set the value for that option.
+            options[key] = host_cfg[key]
+          end
+        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
 
@@ -131,6 +155,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 +212,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.8.1".freeze
+  VERSION = "3.8.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.8.1
+  version: 3.8.5
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable