winrm 2.3.9 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2ad7fa7e2a15820a43f37d4dc3f68074d4700a9c2fe4a69f2832f51f4ae71c9
-  data.tar.gz: 5299213d602e9c74498de6e8b4e5d67a79138fceb2de76c1c26d8f41aacd8561
+  metadata.gz: b4edbd0e2fca0dd65b9b1ba172f525b9473c7b07ddd2b5fd25c422f00e32164f
+  data.tar.gz: dcba3b6b6c8bf4653a588a0d2d2d70d286f19f831c384c107d0b796cdc77e5dc
 SHA512:
-  metadata.gz: 60378036a89315c7651dfb633686cd404119a148b1dd40c3f16dd3379990aeff7662e6b6233cb4c074515bcbd0a29c01f989769ba22f125fc798d82228ab4e04
-  data.tar.gz: 676184a8973b611833fe8f3c826941b376e818fe2a4463ea54a4eef261bbd2067ee290ae072a94d4aa5c367500ad044de4a1c668cec55e45a73a072601f192ec
+  metadata.gz: 359c0beed452df2eb17cfc82230bac1f075ce86eedc0ffb2a516681856d097527b6e2ed6eb256d1f7652201882b5e83399312b51e035ba2281611cc3e2ac1b3a
+  data.tar.gz: 4195fb3f4c60238102b3cd79de8d0840e49ff4425a1590cf9c01ce0563d43b465bfde5e400543f7f2b15915b5d0e8e9f58a9e1321706e6d2ecd55e47f28c3398

data/README.md

@@ -1,5 +1,5 @@
 # Windows Remote Management (WinRM) for Ruby
-[![build](https://github.com/WinRb/WinRM/actions/workflows/build.yml/badge.svg)](https://github.com/WinRb/WinRM/actions/workflows/build.yml)
+[![build](https://github.com/WinRb/WinRM/actions/workflows/ci.yml/badge.svg)](https://github.com/WinRb/WinRM/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/winrm.svg)](http://badge.fury.io/rb/winrm)
 
 This is a SOAP library that uses the functionality in Windows Remote
@@ -11,7 +11,7 @@ site](http://msdn.microsoft.com/en-us/library/aa384426.aspx).
 As of version 2.0, this gem retains the WinRM name but all powershell calls use the more modern [Powershell Remoting Protocol (PSRP)](https://msdn.microsoft.com/en-us/library/dd357801.aspx) for initializing runspace pools as well as creating and processing powershell pipelines.
 
 ## Supported Ruby Versions
-Ruby 3.0 or higher is required. If you need to use an older version of Ruby you'll need to use a previous version of this gem.
+Ruby 3.2 or higher is required. If you need to use an older version of Ruby you'll need to use a previous version of this gem.
 
 ## Supported WinRM Versions
 WinRM 1.1 is supported, however 2.0 and higher is recommended. [See MSDN](http://technet.microsoft.com/en-us/library/ff520073.aspx) for information about WinRM versions and supported operating systems.
@@ -202,7 +202,7 @@ iex $cmd
 ## Setting up Certificate based authentication
 Perform the following steps to authenticate with a certificate instead of a username and password:
 
-1. Generate a certificate with an Extended Key Usage of Client Authentication and a Subject Alternative Name with the UPN of the user. See this [powershell function](https://github.com/WinRb/WinRM/blob/master/WinrmAppveyor.psm1#L1) as an example of using `openssl` to create a self signed user certificate in `.pem` and `.pfx` formats along with the private key file.
+1. Generate a certificate with an Extended Key Usage of Client Authentication and a Subject Alternative Name with the UPN of the user. See this [powershell function](https://github.com/WinRb/WinRM/blob/main/WinrmAppveyor.psm1#L1) as an example of using `openssl` to create a self signed user certificate in `.pem` and `.pfx` formats along with the private key file.
 
 2. Import the pfx file into the `TrustedPeople` directory of the `LocalMachine` certificate store on the windows endpoint.
 
@@ -215,7 +215,7 @@ Perform the following steps to authenticate with a certificate instead of a user
 See [this post](http://www.hurryupandwait.io/blog/certificate-password-less-based-authentication-in-winrm) for more details on certificate authentication.
 
 ## Logging
-The `WinRM::Connection` exposes a `logger` attribute and uses the [logging](https://rubygems.org/gems/logging) gem to manage logging behavior. By default this appends to `STDOUT` and has a level of `:warn`, but one can adjust the level or add additional appenders.
+The `WinRM::Connection` exposes a `logger` attribute and uses the Ruby standard library [Logger](https://docs.ruby-lang.org/en/master/Logger.html). By default this logs to `STDOUT` with a level of `:warn`, but one can adjust the level or replace the logger entirely.
 ```ruby
 conn = WinRM::Connection.new(opts)
 
@@ -223,14 +223,18 @@ conn = WinRM::Connection.new(opts)
 conn.logger.level = :error
 
 # Log to a file
-conn.logger.add_appenders(Logging.appenders.file('error.log'))
+conn.logger = Logger.new('error.log')
 ```
 
-If a consuming application uses its own logger that complies to the logging API, you can simply swap it in:
+The default log level can also be set with the `WINRM_LOG` environment variable (`debug`, `info`, `warn`, `error` or `fatal`).
+
+If a consuming application uses its own logger that complies to the stdlib `Logger` API, you can simply swap it in:
 ```ruby
 conn.logger = my_logger
 ```
 
+Upgrading from the `logging` gem: the one `logging`-specific call that used to work, `conn.logger.add_appenders(...)`, is still accepted but logs a deprecation warning and has no effect. Configure the stdlib logger directly (or inject your own) instead.
+
 ## Troubleshooting
 You may have some errors like ```WinRM::WinRMAuthorizationError```. See [this post](http://www.hurryupandwait.io/blog/understanding-and-troubleshooting-winrm-connection-and-authentication-a-thrill-seekers-guide-to-adventure) for tips and troubleshooting steps related to winrm connection and authentication issues.
 
@@ -241,7 +245,7 @@ You may have some errors like ```WinRM::WinRMAuthorizationError```. See [this po
 3. Run the unit and integration tests (bundle exec rake integration)
 4. Commit your changes (git commit -am "Added a sweet feature")
 5. Push to the branch (git push origin my_feature_branch)
-6. Create a pull requst from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
+6. Create a pull request from your branch into main (Please be sure to provide enough detail for us to cipher what this change is doing)
 
 ### Running the tests
 

data/lib/winrm/compat_logger.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module WinRM
+  # Backwards-compatible default for `Connection#logger`.
+  #
+  # WinRM used to expose a `logging`-gem logger here; it now exposes a plain
+  # stdlib {Logger} instead. This subclass keeps the small `logging`-specific
+  # API callers actually used (`add_appenders`) working while emitting a
+  # deprecation warning, so existing code keeps running instead of breaking
+  # on upgrade. Everything else is exactly stdlib `Logger` behavior.
+  class CompatLogger < ::Logger
+    # Accepts `logging`-gem-style appenders for backwards compatibility.
+    # Stdlib loggers write to their log device, so appenders have no
+    # equivalent here and are ignored.
+    def add_appenders(*_appenders)
+      deprecate_appenders unless @appenders_deprecated
+      nil
+    end
+
+    private
+
+    def deprecate_appenders
+      @appenders_deprecated = true
+      Kernel.warn '[DEPRECATION] WinRM: `logger.add_appenders` is deprecated and has no effect. ' \
+           'Configure the stdlib logger directly or inject your own via `Connection#logger=`.'
+    end
+  end
+end

data/lib/winrm/connection.rb

@@ -65,9 +65,7 @@ module WinRM
     end
 
     def configure_logger
-      @logger = Logging.logger[self]
-      logger.level = :warn
-      logger.add_appenders(Logging.appenders.stdout)
+      @logger = WinRM::CompatLogger.new($stdout, progname: 'WinRM', level: WinRM.default_log_level)
     end
 
     def shell_factory
@@ -77,7 +75,7 @@ module WinRM
     def transport
       @transport ||= begin
         transport_factory = WinRM::HTTP::TransportFactory.new
-        transport_factory.create_transport(@connection_opts)
+        transport_factory.create_transport(@connection_opts.merge(logger: logger))
       end
     end
   end

data/lib/winrm/http/transport.rb

@@ -26,7 +26,8 @@ module WinRM
       def initialize(endpoint, options)
         @endpoint = endpoint.is_a?(String) ? URI.parse(endpoint) : endpoint
         @httpcli = HTTPClient.new
-        @logger = Logging.logger[self]
+        @logger = options[:logger] ||
+                  Logger.new($stdout, progname: 'WinRM', level: WinRM.default_log_level)
         @httpcli.receive_timeout = options[:receive_timeout]
         @httpcli.default_header = { 'User-Agent': options[:user_agent] }
       end

data/lib/winrm/psrp/fragment.rb

@@ -19,27 +19,27 @@ module WinRM
     # PowerShell Remoting Protocol message fragment.
     class Fragment
       # Creates a new PSRP message fragment
-      # @param object_id [Integer] The id of the fragmented message.
+      # @param message_id [Integer] The id of the fragmented message.
       # @param blob [Array] Array of fragmented bytes.
       # @param fragment_id [Integer] The id of this fragment
       # @param start_fragment [Boolean] If the fragment is the first fragment
       # @param end_fragment [Boolean] If the fragment is the last fragment
-      def initialize(object_id, blob, fragment_id = 0, start_fragment = true, end_fragment = true)
-        @object_id = object_id
+      def initialize(message_id, blob, fragment_id = 0, start_fragment = true, end_fragment = true)
+        @message_id = message_id
         @blob = blob
         @fragment_id = fragment_id
         @start_fragment = start_fragment
         @end_fragment = end_fragment
       end
 
-      attr_reader :object_id, :fragment_id, :end_fragment, :start_fragment, :blob
+      attr_reader :message_id, :fragment_id, :end_fragment, :start_fragment, :blob
 
       # Returns the raw PSRP message bytes ready for transfer to Windows inside a
       # WinRM message.
       # @return [Array<Byte>] Unencoded raw byte array of the PSRP message.
       def bytes
         [
-          int64be(object_id),
+          int64be(message_id),
           int64be(fragment_id),
           end_start_fragment,
           int16be(blob.length),

data/lib/winrm/psrp/message_defragmenter.rb

@@ -26,13 +26,13 @@ module WinRM
       def defragment(base64_bytes)
         fragment = fragment_from(Base64.decode64(base64_bytes))
 
-        @messages[fragment.object_id] ||= []
-        @messages[fragment.object_id].push fragment
+        @messages[fragment.message_id] ||= []
+        @messages[fragment.message_id].push fragment
 
         # rubocop:disable Style/GuardClause
         if fragment.end_fragment
           blob = []
-          @messages.delete(fragment.object_id).each { |frag| blob += frag.blob }
+          @messages.delete(fragment.message_id).each { |frag| blob += frag.blob }
           return message_from(blob.pack('C*'))
         end
         # rubocop:enable Style/GuardClause

data/lib/winrm/psrp/message_fragmenter.rb

@@ -22,15 +22,15 @@ module WinRM
       DEFAULT_BLOB_LENGTH = 32_768
 
       def initialize(max_blob_length = DEFAULT_BLOB_LENGTH)
-        @object_id = 0
+        @message_id = 0
         @max_blob_length = max_blob_length || DEFAULT_BLOB_LENGTH
       end
 
-      attr_reader :object_id
+      attr_reader :message_id
       attr_accessor :max_blob_length
 
       def fragment(message)
-        @object_id += 1
+        @message_id += 1
         message_bytes = message.bytes
         bytes_fragmented = 0
         fragment_id = 0
@@ -40,7 +40,7 @@ module WinRM
           last_byte = bytes_fragmented + max_blob_length
           last_byte = message_bytes.length if last_byte > message_bytes.length
           fragment = Fragment.new(
-            object_id,
+            message_id,
             message.bytes[bytes_fragmented..last_byte - 1],
             fragment_id,
             bytes_fragmented.zero?,

data/lib/winrm/shells/base.rb

@@ -94,8 +94,36 @@ module WinRM
         @shell_id = nil
       end
 
+      # Ruby 3.1+ introduced a change where finalizers cannot allocate new threads.
+      # This can raise a ThreadError when the WinRM shell cleanup tries to run in a Thread
+      # during garbage collection. Previously, the gem used Thread.new in finalizers.
+      #
+      # Our solution preserves original behavior safely:
+      # 1. Attempt cleanup in a new thread (same as before) for normal execution.
+      # 2. If a ThreadError occurs specifically due to "can't alloc thread",
+      #    defer cleanup to an at_exit block to ensure the shell is closed properly
+      #    without crashing the program.
+      # 3. Any other ThreadError is re-raised to avoid hiding unexpected issues.
       def self.finalize(connection_opts, transport, shell_id)
-        proc { Thread.new { close_shell(connection_opts, transport, shell_id) } }
+        proc do
+          begin
+            # Attempt normal cleanup in a new thread (preserves existing behavior)
+            Thread.new { close_shell(connection_opts, transport, shell_id) }
+          rescue ThreadError => e
+            # Only handle the specific Ruby 3.1+ GC thread allocation restriction
+            raise unless e.message.include?("can't alloc thread")
+
+            # Defer cleanup to at_exit when thread allocation is permitted
+            at_exit do
+              begin
+                close_shell(connection_opts, transport, shell_id)
+              rescue StandardError => cleanup_error
+                # Warn about cleanup failures in deferred context only
+                warn "[WinRM] Deferred shell cleanup failed: #{cleanup_error.class}: #{cleanup_error.message}"
+              end
+            end
+          end
+        end
       end
 
       protected

data/lib/winrm/version.rb

@@ -1,5 +1,5 @@
 # WinRM module
 module WinRM
   # The version of the WinRM library
-  VERSION = '2.3.9'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/lib/winrm.rb

@@ -1,37 +1,43 @@
-# Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require 'logging'
-require_relative 'winrm/version'
-require_relative 'winrm/connection'
-require_relative 'winrm/exceptions'
-
-# Main WinRM module entry point
-module WinRM
-  # Enable logging if it is requested. We do this before
-  # anything else so that we can setup the output before
-  # any logging occurs.
-  if ENV['WINRM_LOG'] && ENV['WINRM_LOG'] != ''
-    begin
-      Logging.logger.root.level = ENV['WINRM_LOG']
-      Logging.logger.root.appenders = Logging.appenders.stderr
-    rescue ArgumentError
-      # This means that the logging level wasn't valid
-      warn "Invalid WINRM_LOG level is set: #{ENV['WINRM_LOG']}"
-      warn ''
-      warn 'Please use one of the standard log levels: ' \
-        'debug, info, warn, or error'
-    end
-  end
-end
+# Copyright 2010 Dan Wanek <dan.wanek@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'logger'
+require_relative 'winrm/compat_logger'
+require_relative 'winrm/version'
+require_relative 'winrm/connection'
+require_relative 'winrm/exceptions'
+
+# Main WinRM module entry point
+module WinRM
+  LOG_LEVELS = %w[debug info warn error fatal].freeze
+
+  # Default log level used by WinRM loggers, controlled by the
+  # WINRM_LOG environment variable. Falls back to :warn when unset
+  # or invalid.
+  # @return [Symbol] One of :debug, :info, :warn, :error or :fatal
+  def self.default_log_level
+    level = ENV.fetch('WINRM_LOG', '').downcase
+    return :warn if level.empty?
+
+    unless LOG_LEVELS.include?(level)
+      warn "Invalid WINRM_LOG level is set: #{ENV.fetch('WINRM_LOG', nil)}"
+      warn ''
+      warn 'Please use one of the standard log levels: ' \
+        'debug, info, warn, or error'
+      return :warn
+    end
+
+    level.to_sym
+  end
+end

metadata

@@ -1,18 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: winrm
 version: !ruby/object:Gem::Version
-  version: 2.3.9
+  version: 2.4.0
 platform: ruby
 authors:
 - Dan Wanek
 - Paul Morton
 - Matt Wrock
 - Shawn Neal
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2026-09-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -90,25 +103,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.0.2
 - !ruby/object:Gem::Dependency
-  name: logging
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
@@ -161,22 +168,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.3'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.3'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rb-readline
   requirement: !ruby/object:Gem::Requirement
@@ -211,14 +212,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: '1.87'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: '1.87'
 - !ruby/object:Gem::Dependency
   name: rubyntlm
   requirement: !ruby/object:Gem::Requirement
@@ -249,13 +250,14 @@ executables:
 - rwinrm
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 files:
 - LICENSE
 - README.md
 - bin/rwinrm
 - lib/winrm.rb
+- lib/winrm/compat_logger.rb
 - lib/winrm/connection.rb
 - lib/winrm/connection_opts.rb
 - lib/winrm/exceptions.rb
@@ -313,7 +315,6 @@ licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options:
 - "-x"
 - test/
@@ -325,15 +326,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby library for Windows Remote Management
 test_files: []