chef-winrm 2.3.11 → 2.3.12

data/lib/chef-winrm/psrp/message_defragmenter.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'fragment'
+require_relative "fragment"
 
 module WinRM
   # PowerShell Remoting Protcol module
@@ -26,35 +26,35 @@ 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.psrp_object_id] ||= []
+        @messages[fragment.psrp_object_id].push fragment
 
         # rubocop:disable Style/GuardClause
         if fragment.end_fragment
           blob = []
-          @messages.delete(fragment.object_id).each { |frag| blob += frag.blob }
-          return message_from(blob.pack('C*'))
+          @messages.delete(fragment.psrp_object_id).each { |frag| blob += frag.blob }
+          message_from(blob.pack("C*"))
         end
         # rubocop:enable Style/GuardClause
       end
 
       def fragment_from(byte_string)
         Fragment.new(
-          byte_string[0..7].reverse.unpack('Q')[0],
+          byte_string[0..7].reverse.unpack("Q")[0],
           byte_string[21..-1].bytes,
-          byte_string[8..15].reverse.unpack('Q')[0],
-          byte_string[16].unpack('C')[0][0] == 1,
-          byte_string[16].unpack('C')[0][1] == 1
+          byte_string[8..15].reverse.unpack("Q")[0],
+          byte_string[16].unpack("C")[0][0] == 1,
+          byte_string[16].unpack("C")[0][1] == 1
         )
       end
 
       def message_from(byte_string)
         Message.new(
-          '00000000-0000-0000-0000-000000000000',
-          byte_string[4..7].unpack('V')[0],
+          "00000000-0000-0000-0000-000000000000",
+          byte_string[4..7].unpack("V")[0],
           byte_string[40..-1],
-          '00000000-0000-0000-0000-000000000000',
-          byte_string[0..3].unpack('V')[0]
+          "00000000-0000-0000-0000-000000000000",
+          byte_string[0..3].unpack("V")[0]
         )
       end
     end

data/lib/chef-winrm/psrp/message_factory.rb

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'erubi'
-require_relative 'message'
+require "erubi"
+require_relative "message"
 
 module WinRM
   module PSRP
@@ -26,7 +26,7 @@ module WinRM
           Message.new(
             runspace_pool_id,
             Message::MESSAGE_TYPES[:session_capability],
-            render('session_capability')
+            render("session_capability")
           )
         end
 
@@ -36,7 +36,7 @@ module WinRM
           Message.new(
             runspace_pool_id,
             Message::MESSAGE_TYPES[:init_runspacepool],
-            render('init_runspace_pool')
+            render("init_runspace_pool")
           )
         end
 
@@ -49,7 +49,7 @@ module WinRM
           Message.new(
             runspace_pool_id,
             Message::MESSAGE_TYPES[:create_pipeline],
-            render('create_pipeline', command: command.encode(xml: :text)),
+            render("create_pipeline", command: command.encode(xml: :text)),
             pipeline_id
           )
         end

data/lib/chef-winrm/psrp/message_fragmenter.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'fragment'
+require_relative "fragment"
 
 module WinRM
   # PowerShell Remoting Protcol module
@@ -22,15 +22,14 @@ module WinRM
       DEFAULT_BLOB_LENGTH = 32_768
 
       def initialize(max_blob_length = DEFAULT_BLOB_LENGTH)
-        @object_id = 0
+        @custom_object_id = 0
         @max_blob_length = max_blob_length || DEFAULT_BLOB_LENGTH
       end
 
-      attr_reader :object_id
       attr_accessor :max_blob_length
 
       def fragment(message)
-        @object_id += 1
+        @custom_object_id += 1
         message_bytes = message.bytes
         bytes_fragmented = 0
         fragment_id = 0
@@ -40,10 +39,10 @@ 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,
+            custom_object_id,
             message.bytes[bytes_fragmented..last_byte - 1],
             fragment_id,
-            bytes_fragmented.zero?,
+            bytes_fragmented == 0,
             last_byte == message_bytes.length
           )
           fragment_id += 1
@@ -53,6 +52,10 @@ module WinRM
 
         fragment
       end
+
+      private
+
+      attr_reader :custom_object_id
     end
   end
 end

data/lib/chef-winrm/psrp/powershell_output_decoder.rb

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'base64' unless defined?(Base64)
-require_relative 'message'
-require_relative 'message_data/pipeline_state'
+require "base64" unless defined?(Base64)
+require_relative "message"
+require_relative "message_data/pipeline_state"
 
 module WinRM
   module PSRP
@@ -50,42 +50,38 @@ module WinRM
       end
 
       def decode_host_call(message)
-        text = begin
-          case message.parsed_data.method_identifier
-          when /WriteLine/, 'WriteErrorLine'
+        text = case message.parsed_data.method_identifier
+          when /WriteLine/, "WriteErrorLine"
             "#{message.parsed_data.method_parameters[:s]}\r\n"
-          when 'WriteDebugLine'
+          when "WriteDebugLine"
             "Debug: #{message.parsed_data.method_parameters[:s]}\r\n"
-          when 'WriteWarningLine'
+          when "WriteWarningLine"
             "Warning: #{message.parsed_data.method_parameters[:s]}\r\n"
-          when 'WriteVerboseLine'
+          when "WriteVerboseLine"
             "Verbose: #{message.parsed_data.method_parameters[:s]}\r\n"
           when /Write[1-2]/
             message.parsed_data.method_parameters[:s]
-          end
-        end
+               end
 
         hex_decode(text)
       end
 
       def decode_error_record(message)
         parsed = message.parsed_data
-        text = begin
-          if message.type == WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
-            render_exception_as_error_record(parsed.exception_as_error_record)
-          else
-            case parsed.fully_qualified_error_id
-            when 'Microsoft.PowerShell.Commands.WriteErrorException'
-              render_write_error_exception(parsed)
-            when 'NativeCommandError'
-              render_native_command_error(parsed)
-            when 'NativeCommandErrorMessage'
-              parsed.exception[:message]
-            else
-              render_exception(parsed)
-            end
-          end
-        end
+        text = if message.type == WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
+                 render_exception_as_error_record(parsed.exception_as_error_record)
+               else
+                 case parsed.fully_qualified_error_id
+                 when "Microsoft.PowerShell.Commands.WriteErrorException"
+                   render_write_error_exception(parsed)
+                 when "NativeCommandError"
+                   render_native_command_error(parsed)
+                 when "NativeCommandErrorMessage"
+                   parsed.exception[:message]
+                 else
+                   render_exception(parsed)
+                 end
+               end
 
         hex_decode(text)
       end
@@ -129,11 +125,11 @@ EOH
         return unless text
 
         text.gsub(/_x(\h\h\h\h)_/) do
-          decoded_text = Regexp.last_match[1].hex.chr.force_encoding('utf-8')
+          decoded_text = Regexp.last_match[1].hex.chr.force_encoding("utf-8")
           if decoded_text.respond_to?(:scrub)
             decoded_text.scrub
           else
-            decoded_text.encode('utf-16', invalid: :replace, undef: :replace).encode('utf-8')
+            decoded_text.encode("utf-16", invalid: :replace, undef: :replace).encode("utf-8")
           end
         end
       end

data/lib/chef-winrm/psrp/receive_response_reader.rb

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'nori'
-require_relative 'powershell_output_decoder'
-require_relative 'message_defragmenter'
+require "nori"
+require_relative "powershell_output_decoder"
+require_relative "message_defragmenter"
 
 module WinRM
   module PSRP
@@ -77,7 +77,7 @@ module WinRM
         when WinRM::PSRP::Message::MESSAGE_TYPES[:error_record]
           type = :stderr
         when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_host_call]
-          type = :stderr if message.data.include?('WriteError')
+          type = :stderr if message.data.include?("WriteError")
         when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
           type = :stderr if message.parsed_data.pipeline_state == WinRM::PSRP::MessageData::PipelineState::FAILED
         end
@@ -88,7 +88,7 @@ module WinRM
         parsed = message.parsed_data
         return nil unless parsed.is_a?(MessageData::PipelineHostCall)
 
-        parsed.method_parameters[:i32].to_i if parsed.method_identifier == 'SetShouldExit'
+        parsed.method_parameters[:i32].to_i if parsed.method_identifier == "SetShouldExit"
       end
     end
   end

data/lib/chef-winrm/shells/base.rb

@@ -12,27 +12,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'retryable'
-require_relative '../http/transport'
-require_relative '../wsmv/cleanup_command'
-require_relative '../wsmv/close_shell'
-require_relative '../wsmv/command'
-require_relative '../wsmv/command_output'
-require_relative '../wsmv/receive_response_reader'
-require_relative '../wsmv/create_shell'
-require_relative '../wsmv/soap'
+require_relative "retryable"
+require_relative "../http/transport"
+require_relative "../wsmv/cleanup_command"
+require_relative "../wsmv/close_shell"
+require_relative "../wsmv/command"
+require_relative "../wsmv/command_output"
+require_relative "../wsmv/receive_response_reader"
+require_relative "../wsmv/create_shell"
+require_relative "../wsmv/soap"
 
 module WinRM
   module Shells
     # Base class for remote shell
     class Base
-      TOO_MANY_COMMANDS = '2150859174'.freeze
-      ERROR_OPERATION_ABORTED = '995'.freeze
-      SHELL_NOT_FOUND = '2150858843'.freeze
+      TOO_MANY_COMMANDS = "2150859174".freeze
+      ERROR_OPERATION_ABORTED = "995".freeze
+      SHELL_NOT_FOUND = "2150858843".freeze
 
       FAULTS_FOR_RESET = [
-        '2150858843', # Shell has been closed
-        '2147943418', # Error reading registry key
+        "2150858843", # Shell has been closed
+        "2147943418", # Error reading registry key
         TOO_MANY_COMMANDS, # Maximum commands per user exceeded
       ].freeze
 
@@ -121,7 +121,7 @@ module WinRM
           shell_id: shell_id,
           command_id: command_id,
           shell_uri: shell_uri,
-          out_streams: out_streams
+          out_streams: out_streams,
         }
         WinRM::WSMV::CommandOutput.new(connection_opts, cmd_out_opts)
       end
@@ -146,12 +146,13 @@ module WinRM
 
       def reset_on_error(error)
         close if error.fault_code == TOO_MANY_COMMANDS
-        logger.debug('[WinRM] opening new shell since the current one was deleted')
+        logger.debug("[WinRM] opening new shell since the current one was deleted")
         @shell_id = nil
       end
 
       def cleanup_command(command_id)
         return unless shell_id
+
         logger.debug("[WinRM] cleaning up command_id: #{command_id} on shell_id #{shell_id}")
         cleanup_msg = WinRM::WSMV::CleanupCommand.new(
           connection_opts,

data/lib/chef-winrm/shells/cmd.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'base'
+require_relative "base"
 
 module WinRM
   module Shells
@@ -52,7 +52,7 @@ module WinRM
       end
 
       def out_streams
-        %w[stdout stderr]
+        %w{stdout stderr}
       end
     end
   end

data/lib/chef-winrm/shells/power_shell.rb

@@ -12,15 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'securerandom' unless defined?(SecureRandom)
-require_relative 'base'
-require_relative '../psrp/message_fragmenter'
-require_relative '../psrp/receive_response_reader'
-require_relative '../wsmv/configuration'
-require_relative '../wsmv/create_pipeline'
-require_relative '../wsmv/send_data'
-require_relative '../wsmv/init_runspace_pool'
-require_relative '../wsmv/keep_alive'
+require "securerandom" unless defined?(SecureRandom)
+require_relative "base"
+require_relative "../psrp/message_fragmenter"
+require_relative "../psrp/receive_response_reader"
+require_relative "../wsmv/configuration"
+require_relative "../wsmv/create_pipeline"
+require_relative "../wsmv/send_data"
+require_relative "../wsmv/init_runspace_pool"
+require_relative "../wsmv/keep_alive"
 
 module WinRM
   module Shells
@@ -78,7 +78,7 @@ module WinRM
             # error attempting to query winrm configuration.
             # we will assin a small default and adjust to a protocol
             # appropriate max length when that info is available
-            raise unless e.fault_code == '5'
+            raise unless e.fault_code == "5"
 
             WinRM::PSRP::MessageFragmenter::DEFAULT_BLOB_LENGTH
           rescue WinRMSoapFault
@@ -125,7 +125,7 @@ module WinRM
       end
 
       def out_streams
-        %w[stdout]
+        %w{stdout}
       end
 
       private
@@ -137,8 +137,8 @@ module WinRM
       def empty_pipeline_envelope
         WinRM::WSMV::CreatePipeline.new(
           connection_opts,
-          '00000000-0000-0000-0000-000000000000',
-          '00000000-0000-0000-0000-000000000000'
+          "00000000-0000-0000-0000-000000000000",
+          "00000000-0000-0000-0000-000000000000"
         ).build
       end
 
@@ -148,16 +148,16 @@ module WinRM
           msg = config_msg.build
           resp_doc = transport.send_request(msg)
           REXML::XPath.first(resp_doc, "//*[local-name() = 'MaxEnvelopeSizekb']").text.to_i
-        rescue REXML::ParseException
-          logger.debug("[WinRM] Endpoint doesn't support config request for MaxEnvelopeSizekb")
-          raise
+                                  rescue REXML::ParseException
+                                    logger.debug("[WinRM] Endpoint doesn't support config request for MaxEnvelopeSizekb")
+                                    raise
         end
       end
 
       def open_shell_payload(shell_id)
         [
           WinRM::PSRP::MessageFactory.session_capability_message(shell_id),
-          WinRM::PSRP::MessageFactory.init_runspace_pool_message(shell_id)
+          WinRM::PSRP::MessageFactory.init_runspace_pool_message(shell_id),
         ].map do |message|
           fragmenter.fragment(message).bytes
         end.flatten
@@ -191,7 +191,7 @@ module WinRM
       # which defaults to a 150 MaxEnvelopeSizeKB
       # later versions default to 500
       def default_protocol_envelope_size(protocol_version)
-        protocol_version > '2.1' ? 512000 : 153600
+        protocol_version > "2.1" ? 512000 : 153600
       end
 
       def fragmenter

data/lib/chef-winrm/shells/retryable.rb

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative '../exceptions'
+require_relative "../exceptions"
 
 module WinRM
   module Shells

data/lib/chef-winrm/shells/shell_factory.rb

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'base'
-require_relative 'cmd'
-require_relative 'power_shell'
+require_relative "base"
+require_relative "cmd"
+require_relative "power_shell"
 
 module WinRM
   module Shells
@@ -39,7 +39,7 @@ module WinRM
         args = [
           @connection_opts,
           @transport,
-          @logger
+          @logger,
         ]
         # winrm-elevated has an initializer with no shell_opts so don't break it
         args << shell_opts unless shell_opts.nil? || shell_opts.empty?
@@ -47,7 +47,7 @@ module WinRM
           WinRM::Shells.const_get(type).new(*args)
         else
           message = "#{type} is not a valid WinRM shell type. " \
-            'Expected either :cmd, :powershell or pluggable shell.'
+            "Expected either :cmd, :powershell or pluggable shell."
           raise WinRM::InvalidShellError, message
         end
       end

data/lib/chef-winrm/version.rb

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

data/lib/chef-winrm/wsmv/base.rb

@@ -12,11 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'base64'
-require 'builder'
-require 'gyoku'
-require_relative 'soap'
-require_relative 'header'
+require "base64" unless defined?(Base64)
+require "builder"
+require "chef-gyoku"
+require_relative "soap"
+require_relative "header"
 
 module WinRM
   module WSMV
@@ -28,7 +28,7 @@ module WinRM
       # Builds the WSMV message XML payload
       def build
         builder = Builder::XmlMarkup.new
-        builder.instruct!(:xml, encoding: 'UTF-8')
+        builder.instruct!(:xml, encoding: "UTF-8")
         builder.tag! :env, :Envelope, namespaces do |env|
           env.tag!(:env, :Header) do |env_header|
             create_header(env_header)
@@ -50,7 +50,7 @@ module WinRM
       end
 
       def encode_bytes(bytes)
-        Base64.strict_encode64(bytes.pack('C*'))
+        Base64.strict_encode64(bytes.pack("C*"))
       end
     end
   end

data/lib/chef-winrm/wsmv/cleanup_command.rb

@@ -12,15 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'base'
+require_relative "base"
 
 module WinRM
   module WSMV
     # WSMV message to execute a command inside a remote shell
     class CleanupCommand < Base
       def initialize(session_opts, opts)
-        raise 'opts[:shell_id] is required' unless opts[:shell_id]
-        raise 'opts[:command_id] is required' unless opts[:command_id]
+        raise "opts[:shell_id] is required" unless opts[:shell_id]
+        raise "opts[:command_id] is required" unless opts[:command_id]
 
         @session_opts = session_opts
         @shell_id = opts[:shell_id]
@@ -35,7 +35,7 @@ module WinRM
       end
 
       def create_body(body)
-        body.tag!("#{NS_WIN_SHELL}:Signal", 'CommandId' => @command_id) do |cl|
+        body.tag!("#{NS_WIN_SHELL}:Signal", "CommandId" => @command_id) do |cl|
           cl << Gyoku.xml(cleanup_body)
         end
       end
@@ -44,15 +44,15 @@ module WinRM
 
       def cleanup_header
         merge_headers(shared_headers(@session_opts),
-                      resource_uri_shell(@shell_uri),
-                      action_signal,
-                      selector_shell_id(@shell_id))
+          resource_uri_shell(@shell_uri),
+          action_signal,
+          selector_shell_id(@shell_id))
       end
 
       def cleanup_body
         {
           "#{NS_WIN_SHELL}:Code" =>
-            'http://schemas.microsoft.com/wbem/wsman/1/windows/shell/signal/terminate'
+            "http://schemas.microsoft.com/wbem/wsman/1/windows/shell/signal/terminate",
         }
       end
     end

data/lib/chef-winrm/wsmv/close_shell.rb

@@ -12,14 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'base'
+require_relative "base"
 
 module WinRM
   module WSMV
     # WSMV message to close a remote shell
     class CloseShell < Base
       def initialize(session_opts, shell_opts)
-        raise 'shell_opts[:shell_id] is required' unless shell_opts[:shell_id]
+        raise "shell_opts[:shell_id] is required" unless shell_opts[:shell_id]
 
         @session_opts = session_opts
         @shell_id = shell_opts[:shell_id]
@@ -40,9 +40,9 @@ module WinRM
 
       def close_header
         merge_headers(shared_headers(@session_opts),
-                      resource_uri_shell(@shell_uri),
-                      action_delete,
-                      selector_shell_id(@shell_id))
+          resource_uri_shell(@shell_uri),
+          action_delete,
+          selector_shell_id(@shell_id))
       end
     end
   end