winrm 2.2.3 → 2.3.6

data/lib/winrm/psrp/powershell_output_decoder.rb

@@ -1,144 +1,142 @@
-# -*- encoding: utf-8 -*-
-#
-# Copyright 2016 Matt Wrock <matt@mattwrock.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 'base64'
-require_relative 'message'
-require_relative 'message_data/pipeline_state'
-
-module WinRM
-  module PSRP
-    # Handles decoding a raw powershell output response
-    class PowershellOutputDecoder
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # Decode the raw SOAP output into decoded PSRP message,
-      # Removes BOM and replaces encoded line endings
-      # @param raw_output [String] The raw encoded output
-      # @return [String] The decoded output
-      def decode(message)
-        case message.type
-        when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_output]
-          decode_pipeline_output(message)
-        when WinRM::PSRP::Message::MESSAGE_TYPES[:runspacepool_host_call]
-          decode_host_call(message)
-        when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_host_call]
-          decode_host_call(message)
-        when WinRM::PSRP::Message::MESSAGE_TYPES[:error_record]
-          decode_error_record(message)
-        when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
-          if message.parsed_data.pipeline_state == WinRM::PSRP::MessageData::PipelineState::FAILED
-            decode_error_record(message)
-          end
-        end
-      end
-      # rubocop:enable Metrics/CyclomaticComplexity
-
-      protected
-
-      def decode_pipeline_output(message)
-        message.parsed_data.output
-      end
-
-      def decode_host_call(message)
-        text = begin
-          case message.parsed_data.method_identifier
-          when /WriteLine/, 'WriteErrorLine'
-            "#{message.parsed_data.method_parameters[:s]}\r\n"
-          when 'WriteDebugLine'
-            "Debug: #{message.parsed_data.method_parameters[:s]}\r\n"
-          when 'WriteWarningLine'
-            "Warning: #{message.parsed_data.method_parameters[:s]}\r\n"
-          when 'WriteVerboseLine'
-            "Verbose: #{message.parsed_data.method_parameters[:s]}\r\n"
-          when /Write[1-2]/
-            message.parsed_data.method_parameters[:s]
-          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
-
-        hex_decode(text)
-      end
-
-      def render_write_error_exception(parsed)
-        <<EOH
-#{parsed.invocation_info[:line]} : #{parsed.exception[:message]}
-    + CategoryInfo          : #{parsed.error_category_message}
-    + FullyQualifiedErrorId : #{parsed.fully_qualified_error_id}
-EOH
-      end
-
-      def render_exception(parsed)
-        <<EOH
-#{parsed.exception[:message]}
-#{parsed.invocation_info[:position_message]}
-    + CategoryInfo          : #{parsed.error_category_message}
-    + FullyQualifiedErrorId : #{parsed.fully_qualified_error_id}
-EOH
-      end
-
-      def render_native_command_error(parsed)
-        <<EOH
-#{parsed.invocation_info[:my_command]} : #{parsed.exception[:message]}
-    + CategoryInfo          : #{parsed.error_category_message}
-    + FullyQualifiedErrorId : #{parsed.fully_qualified_error_id}
-EOH
-      end
-
-      def render_exception_as_error_record(parsed)
-        <<EOH
-#{parsed.exception[:message]}
-    + CategoryInfo          : #{parsed.error_category_message}
-    + FullyQualifiedErrorId : #{parsed.fully_qualified_error_id}
-EOH
-      end
-
-      private
-
-      def hex_decode(text)
-        return unless text
-
-        text.gsub(/_x(\h\h\h\h)_/) do
-          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')
-          end
-        end
-      end
-    end
-  end
-end
+# Copyright 2016 Matt Wrock <matt@mattwrock.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 'base64' unless defined?(Base64)
+require_relative 'message'
+require_relative 'message_data/pipeline_state'
+
+module WinRM
+  module PSRP
+    # Handles decoding a raw powershell output response
+    class PowershellOutputDecoder
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # Decode the raw SOAP output into decoded PSRP message,
+      # Removes BOM and replaces encoded line endings
+      # @param raw_output [String] The raw encoded output
+      # @return [String] The decoded output
+      def decode(message)
+        case message.type
+        when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_output]
+          decode_pipeline_output(message)
+        when WinRM::PSRP::Message::MESSAGE_TYPES[:runspacepool_host_call]
+          decode_host_call(message)
+        when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_host_call]
+          decode_host_call(message)
+        when WinRM::PSRP::Message::MESSAGE_TYPES[:error_record]
+          decode_error_record(message)
+        when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
+          if message.parsed_data.pipeline_state == WinRM::PSRP::MessageData::PipelineState::FAILED
+            decode_error_record(message)
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      protected
+
+      def decode_pipeline_output(message)
+        message.parsed_data.output
+      end
+
+      def decode_host_call(message)
+        text = begin
+          case message.parsed_data.method_identifier
+          when /WriteLine/, 'WriteErrorLine'
+            "#{message.parsed_data.method_parameters[:s]}\r\n"
+          when 'WriteDebugLine'
+            "Debug: #{message.parsed_data.method_parameters[:s]}\r\n"
+          when 'WriteWarningLine'
+            "Warning: #{message.parsed_data.method_parameters[:s]}\r\n"
+          when 'WriteVerboseLine'
+            "Verbose: #{message.parsed_data.method_parameters[:s]}\r\n"
+          when /Write[1-2]/
+            message.parsed_data.method_parameters[:s]
+          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
+
+        hex_decode(text)
+      end
+
+      def render_write_error_exception(parsed)
+        <<EOH
+#{parsed.invocation_info[:line]} : #{parsed.exception[:message]}
+    + CategoryInfo          : #{parsed.error_category_message}
+    + FullyQualifiedErrorId : #{parsed.fully_qualified_error_id}
+EOH
+      end
+
+      def render_exception(parsed)
+        <<EOH
+#{parsed.exception[:message]}
+#{parsed.invocation_info[:position_message]}
+    + CategoryInfo          : #{parsed.error_category_message}
+    + FullyQualifiedErrorId : #{parsed.fully_qualified_error_id}
+EOH
+      end
+
+      def render_native_command_error(parsed)
+        <<EOH
+#{parsed.invocation_info[:my_command]} : #{parsed.exception[:message]}
+    + CategoryInfo          : #{parsed.error_category_message}
+    + FullyQualifiedErrorId : #{parsed.fully_qualified_error_id}
+EOH
+      end
+
+      def render_exception_as_error_record(parsed)
+        <<EOH
+#{parsed.exception[:message]}
+    + CategoryInfo          : #{parsed.error_category_message}
+    + FullyQualifiedErrorId : #{parsed.fully_qualified_error_id}
+EOH
+      end
+
+      private
+
+      def hex_decode(text)
+        return unless text
+
+        text.gsub(/_x(\h\h\h\h)_/) do
+          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')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/receive_response_reader.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Matt Wrock <matt@mattwrock.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -41,6 +39,7 @@ module WinRM
         read_response(wsmv_message, wait_for_done_state) do |stream|
           message = defragmenter.defragment(stream[:text])
           next unless message
+
           if block_given?
             yield message
           else
@@ -62,6 +61,7 @@ module WinRM
             output.exitcode = exit_code if exit_code
             decoded_text = @output_decoder.decode(message)
             next unless decoded_text
+
             out = { stream_type(message) => decoded_text }
             output << out
             yield [out[:stdout], out[:stderr]] if block_given?
@@ -79,9 +79,7 @@ module WinRM
         when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_host_call]
           type = :stderr if message.data.include?('WriteError')
         when WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state]
-          if message.parsed_data.pipeline_state == WinRM::PSRP::MessageData::PipelineState::FAILED
-            type = :stderr
-          end
+          type = :stderr if message.parsed_data.pipeline_state == WinRM::PSRP::MessageData::PipelineState::FAILED
         end
         type
       end

data/lib/winrm/psrp/uuid.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright 2016 Shawn Neal <sneal@sneal.net>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -32,6 +30,7 @@ module WinRM
       # @return [Array<byte>] UUID in a Windows GUID compatible byte array layout.
       def uuid_to_windows_guid_bytes(uuid)
         return [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] unless uuid
+
         b = uuid.scan(/[0-9a-fA-F]{2}/).map { |x| x.to_i(16) }
         b[0..3].reverse + b[4..5].reverse + b[6..7].reverse + b[8..15]
       end

data/lib/winrm/shells/base.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-#
 # Copyright 2016 Shawn Neal <sneal@sneal.net>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -86,6 +84,7 @@ module WinRM
       # Closes the shell if one is open
       def close
         return unless shell_id
+
         begin
           self.class.close_shell(connection_opts, transport, shell_id)
         rescue WinRMWSManFault => e
@@ -132,6 +131,7 @@ module WinRM
         yield shell_id, command_id
       rescue WinRMWSManFault => e
         raise unless FAULTS_FOR_RESET.include?(e.fault_code) && (tries -= 1) > 0
+
         reset_on_error(e)
         retry
       ensure
@@ -147,12 +147,14 @@ module WinRM
       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,
           shell_uri: shell_uri,
           shell_id: shell_id,
-          command_id: command_id)
+          command_id: command_id
+        )
         transport.send_request(cleanup_msg.build)
       rescue WinRMWSManFault => e
         raise unless [ERROR_OPERATION_ABORTED, SHELL_NOT_FOUND].include?(e.fault_code)
@@ -174,7 +176,8 @@ module WinRM
       def add_finalizer
         ObjectSpace.define_finalizer(
           self,
-          self.class.finalize(connection_opts, transport, shell_id))
+          self.class.finalize(connection_opts, transport, shell_id)
+        )
       end
 
       def remove_finalizer

data/lib/winrm/shells/cmd.rb

@@ -1,65 +1,63 @@
-# -*- encoding: utf-8 -*-
-#
-# Copyright 2016 Shawn Neal <sneal@sneal.net>
-#
-# 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_relative 'base'
-
-module WinRM
-  module Shells
-    # Proxy to a remote cmd.exe shell
-    class Cmd < Base
-      include WinRM::WSMV::SOAP
-      class << self
-        def finalize(connection_opts, transport, shell_id)
-          proc { Cmd.close_shell(connection_opts, transport, shell_id) }
-        end
-
-        def close_shell(connection_opts, transport, shell_id)
-          msg = WinRM::WSMV::CloseShell.new(connection_opts, shell_id: shell_id)
-          transport.send_request(msg.build)
-        end
-      end
-
-      protected
-
-      def send_command(command, arguments)
-        cmd_msg = WinRM::WSMV::Command.new(
-          connection_opts,
-          shell_id: shell_id,
-          command: command,
-          arguments: arguments
-        )
-        resp_doc = transport.send_request(cmd_msg.build)
-        command_id = REXML::XPath.first(resp_doc, "//#{NS_WIN_SHELL}:CommandId").text
-        logger.debug("[WinRM] Command created for #{command} with id: #{command_id}")
-        command_id
-      end
-
-      def response_reader
-        @response_reader ||= WinRM::WSMV::ReceiveResponseReader.new(transport, logger)
-      end
-
-      def open_shell
-        msg = WinRM::WSMV::CreateShell.new(connection_opts, shell_opts)
-        resp_doc = transport.send_request(msg.build)
-        REXML::XPath.first(resp_doc, "//*[@Name='ShellId']").text
-      end
-
-      def out_streams
-        %w(stdout stderr)
-      end
-    end
-  end
-end
+# Copyright 2016 Shawn Neal <sneal@sneal.net>
+#
+# 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_relative 'base'
+
+module WinRM
+  module Shells
+    # Proxy to a remote cmd.exe shell
+    class Cmd < Base
+      include WinRM::WSMV::SOAP
+      class << self
+        def finalize(connection_opts, transport, shell_id)
+          proc { Cmd.close_shell(connection_opts, transport, shell_id) }
+        end
+
+        def close_shell(connection_opts, transport, shell_id)
+          msg = WinRM::WSMV::CloseShell.new(connection_opts, shell_id: shell_id)
+          transport.send_request(msg.build)
+        end
+      end
+
+      protected
+
+      def send_command(command, arguments)
+        cmd_msg = WinRM::WSMV::Command.new(
+          connection_opts,
+          shell_id: shell_id,
+          command: command,
+          arguments: arguments
+        )
+        resp_doc = transport.send_request(cmd_msg.build)
+        command_id = REXML::XPath.first(resp_doc, "//*[local-name() = 'CommandId']").text
+        logger.debug("[WinRM] Command created for #{command} with id: #{command_id}")
+        command_id
+      end
+
+      def response_reader
+        @response_reader ||= WinRM::WSMV::ReceiveResponseReader.new(transport, logger)
+      end
+
+      def open_shell
+        msg = WinRM::WSMV::CreateShell.new(connection_opts, shell_opts)
+        resp_doc = transport.send_request(msg.build)
+        REXML::XPath.first(resp_doc, "//*[@Name='ShellId']").text
+      end
+
+      def out_streams
+        %w[stdout stderr]
+      end
+    end
+  end
+end