train-winrm 0.2.6 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f72fe0398deeb2ddebaa5bce7177f0bfb5e85394c371a5443d8d08f2dec8c009
-  data.tar.gz: f2201788d2a72840c262312953b57f4d9c391b22ed435c66fa81774539469b3b
+  metadata.gz: f285f418da910b5aa18969c6eb97f9702024bbdbaca9ec085d293708af3172e5
+  data.tar.gz: 81e3e1f9f10a11d62b02911514acbb076d3bcc91424d11d6a39fed1db24afa6f
 SHA512:
-  metadata.gz: 411d8547046c5a3c85bcf327a806227604df7dfa5cdb3ee1972bb6ae5456b96e949e28497f0b0f5af68d402b1802b39282b3271a2c9646908d46e868bf21bff0
-  data.tar.gz: 73045b37df8ed789d94e1aa476b2370128ac812f945c2a9819cb6e15acf977d8483ba241b7dec498b5756482ba080df79f6223ac3c70c005fcfb6b458419186f
+  metadata.gz: 4555a472e56ecf3f72f1f84e2002053d400305370daa41a3f39ce83d993c0859e6e0d089bcab236d173d2fe76bf4731feca62a8591bf63ac7784cf5ca1ccb061
+  data.tar.gz: ef30862cd5a211b093a44779069ff3b0273d50478fec2fe9eb276b630462254a990e8d119226f9f8f8f56bb41b992ae0e7f9374a5ff794a9eec596fadf0e886b

data/lib/train-winrm/connection.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 #
 # Author:: Salim Afiune (<salim@afiunemaya.com.mx>)
 # Author:: Matt Wrock (<matt@mattwrock.com>)
@@ -35,6 +33,8 @@
 
 require "train"
 require "train/plugins"
+# This module may need to directly require WinRM to reference its exception classes
+require "winrm" unless defined?(WinRM)
 
 module TrainPlugins
   module WinRM
@@ -49,6 +49,7 @@ module TrainPlugins
         @connection_retry_sleep = @options.delete(:connection_retry_sleep)
         @max_wait_until_ready   = @options.delete(:max_wait_until_ready)
         @operation_timeout      = @options.delete(:operation_timeout)
+        @shell_type             = @options.delete(:winrm_shell_type)
       end
 
       # (see Base::Connection#close)
@@ -109,15 +110,47 @@ module TrainPlugins
         Train::File::Remote::Windows.new(self, path)
       end
 
-      def run_command_via_connection(command, &data_handler)
+      def run_command_via_connection(command, opts = {}, &data_handler)
         return if command.nil?
 
         logger.debug("[WinRM] #{self} (#{command})")
         out = ""
+        response = nil
+        timeout = opts[:timeout]&.to_i
+
+        # Run the command in a thread, to support timing out the command
+        thr = Thread.new do
+          # Surface any exceptions in this thread back to this method
+          Thread.current.report_on_exception = false
+          Thread.current.abort_on_exception = true
+          begin
+            response = session.run(command) do |stdout, _|
+              yield(stdout) if data_handler && stdout
+              out << stdout if stdout
+            end
+          rescue ::WinRM::WinRMHTTPTransportError => e
+            # If this command hits timeout, there is also a potential race in the HTTP transport
+            # where decryption is attempted on an empty message.
+            raise e unless timeout && e.to_s == "Could not decrypt NTLM message. ()."
+          rescue RuntimeError => e
+            # Ref: https://github.com/WinRb/WinRM/issues/315
+            # If this command hits timeout, calling close with the command currently running causes
+            # a RuntimeError error in WinRM's cleanup code. This specific error can be ignored.
+            # The command will be terminated and further commands can be sent on the connection.
+            raise e unless timeout && e.to_s == "opts[:shell_id] is required"
+          end
+        end
 
-        response = session.run(command) do |stdout, _|
-          yield(stdout) if data_handler && stdout
-          out << stdout if stdout
+        if timeout
+          res = thr.join(timeout)
+          unless res
+            msg = "PowerShell command '(#{command})' reached timeout (#{timeout}s)"
+            logger.info("[WinRM] #{msg}")
+            close
+            raise Train::CommandTimeoutReached.new msg
+          end
+        else
+          thr.join
         end
 
         CommandResult.new(out, response.stderr, response.exitcode)
@@ -197,7 +230,7 @@ module TrainPlugins
           opts[:operation_timeout] = @operation_timeout unless @operation_timeout.nil?
           @service = ::WinRM::Connection.new(options.merge(opts))
           @service.logger = logger
-          @service.shell(:powershell)
+          @service.shell(@shell_type)
         end
       end
 

data/lib/train-winrm/transport.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 #
 # Author:: Salim Afiune (<salim@afiunemaya.com.mx>)
 # Author:: Matt Wrock (<matt@mattwrock.com>)
@@ -21,8 +19,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "rbconfig"
-require "uri"
 require "train"
 require "train/errors"
 require "train/plugins"
@@ -50,6 +46,7 @@ module TrainPlugins
 
       # ref: https://github.com/winrb/winrm#transports
       SUPPORTED_WINRM_TRANSPORTS = %i{negotiate ssl plaintext kerberos}.freeze
+      SUPPORTED_WINRM_SHELL_TYPES = %i{powershell elevated cmd}.freeze
 
       # common target configuration
       option :host, required: true
@@ -76,6 +73,10 @@ module TrainPlugins
       # from the winrm endpoint. Does not mean that the command has
       # completed in this time, only that the server has ack'd the request.
       option :operation_timeout, default: nil
+      option :winrm_shell_type , default: "powershell"
+      option :client_cert , default: nil
+      option :client_key , default: nil
+      option :client_key_pass , default: nil
 
       def initialize(opts)
         super(opts)
@@ -109,6 +110,11 @@ module TrainPlugins
           raise Train::ClientError, "Unsupported transport type: #{winrm_transport.inspect}"
         end
 
+        winrm_shell_type = opts[:winrm_shell_type].to_sym
+        unless SUPPORTED_WINRM_SHELL_TYPES.include?(winrm_shell_type)
+          raise Train::ClientError, "Unsupported winrm shell type: #{winrm_shell_type.inspect}"
+        end
+
         # remove leading '/'
         path = (opts[:path] || "").sub(%r{^/+}, "")
 
@@ -116,6 +122,7 @@ module TrainPlugins
       end
 
       WINRM_FS_SPEC_VERSION = "~> 1.0".freeze
+      WINRM_ELEVATED_SPEC_VERSION = "~> 1.2.2".freeze
 
       # Builds the hash of options needed by the Connection object on
       # construction.
@@ -142,13 +149,17 @@ module TrainPlugins
           service: opts[:kerberos_service],
           ca_trust_file: opts[:ca_trust_file],
           ssl_peer_fingerprint: opts[:ssl_peer_fingerprint],
+          winrm_shell_type: opts[:winrm_shell_type],
+          client_cert: opts[:client_cert],
+          client_key: opts[:client_key],
+          key_pass: opts[:client_key_pass],
         }
       end
 
       # Creates a new WinRM Connection instance and save it for potential
       # future reuse.
       #
-      # @param options [Hash] conneciton options
+      # @param options [Hash] connection options
       # @return [WinRM::Connection] a WinRM Connection instance
       # @api private
       def create_new_connection(options, &block)
@@ -166,32 +177,41 @@ module TrainPlugins
         spec_version = WINRM_FS_SPEC_VERSION.dup
         logger.debug("winrm-fs requested," \
           " loading WinRM::FS gem (#{spec_version})")
-        gem "winrm-fs", spec_version
-        first_load = require "winrm-fs"
-        load_winrm_transport!
+        load_dependency("winrm-fs", spec_version)
+
+        spec_version = WINRM_ELEVATED_SPEC_VERSION.dup
+        logger.debug("winrm-elevated requested," \
+          " loading WinRM-elevated gem (#{spec_version})")
+        load_dependency("winrm-elevated", spec_version)
+      end
+
+      def load_dependency(gem_name, spec_version)
+        gem gem_name, spec_version
+        first_load = require gem_name
+        load_winrm_transport!(gem_name)
 
         if first_load
-          logger.debug("WinRM::FS library loaded")
+          logger.debug("#{gem_name} library loaded")
         else
-          logger.debug("WinRM::FS previously loaded")
+          logger.debug("#{gem_name} previously loaded")
         end
       rescue LoadError => e
         logger.fatal(
-          "The `winrm-fs' gem is missing and must" \
+          "The `#{gem_name}' gem is missing and must" \
           " be installed or cannot be properly activated. Run" \
-          " `gem install winrm-fs --version '#{spec_version}'`" \
+          " `gem install #{gem_name}  --version '#{spec_version}'`" \
           " or add the following to your Gemfile if you are using Bundler:" \
-          " `gem 'winrm-fs', '#{spec_version}'`."
+          " `gem '#{gem_name}', '#{spec_version}'`."
         )
         raise Train::UserError,
-          "Could not load or activate WinRM::FS (#{e.message})"
+          "Could not load or activate #{gem_name} (#{e.message})"
       end
 
       # Load WinRM::Transport code.
       #
       # @api private
-      def load_winrm_transport!
-        silence_warnings { require "winrm-fs" }
+      def load_winrm_transport!(gem_name)
+        silence_warnings { require gem_name }
       end
 
       # Return the last saved WinRM connection instance.

data/lib/train-winrm/version.rb

@@ -5,6 +5,6 @@
 
 module TrainPlugins
   module WinRM
-    VERSION = "0.2.6".freeze
+    VERSION = "0.2.13".freeze
   end
 end

data/lib/train-winrm.rb

@@ -11,7 +11,7 @@
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
-# It's traditonal to keep your gem version in a separate file, so CI can find it easier.
+# It's traditional to keep your gem version in a separate file, so CI can find it easier.
 require_relative "train-winrm/version"
 
 # A train plugin has three components: Transport, Connection, and (optionally) Platform.

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: train-winrm
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.13
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-31 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: winrm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: winrm-elevated
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: winrm-fs
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +90,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: Windows WinRM API Transport for Train