winrm 2.1.0 → 2.1.1

data/lib/winrm/psrp/message_defragmenter.rb

@@ -1,62 +1,62 @@
-# 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_relative 'fragment'
-
-module WinRM
-  # PowerShell Remoting Protcol module
-  module PSRP
-    # PowerShell Remoting Protocol message fragmenter.
-    class MessageDefragmenter
-      def initialize
-        @messages = {}
-      end
-
-      def defragment(base64_bytes)
-        fragment = fragment_from(Base64.decode64(base64_bytes))
-
-        @messages[fragment.object_id] ||= []
-        @messages[fragment.object_id].push fragment
-
-        if fragment.end_fragment
-          blob = []
-          @messages.delete(fragment.object_id).each { |frag| blob += frag.blob }
-          return message_from(blob.pack('C*'))
-        end
-      end
-
-      def fragment_from(byte_string)
-        Fragment.new(
-          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
-        )
-      end
-
-      def message_from(byte_string)
-        Message.new(
-          '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]
-        )
-      end
-    end
-  end
-end
+# 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_relative 'fragment'
+
+module WinRM
+  # PowerShell Remoting Protcol module
+  module PSRP
+    # PowerShell Remoting Protocol message fragmenter.
+    class MessageDefragmenter
+      def initialize
+        @messages = {}
+      end
+
+      def defragment(base64_bytes)
+        fragment = fragment_from(Base64.decode64(base64_bytes))
+
+        @messages[fragment.object_id] ||= []
+        @messages[fragment.object_id].push fragment
+
+        if fragment.end_fragment
+          blob = []
+          @messages.delete(fragment.object_id).each { |frag| blob += frag.blob }
+          return message_from(blob.pack('C*'))
+        end
+      end
+
+      def fragment_from(byte_string)
+        Fragment.new(
+          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
+        )
+      end
+
+      def message_from(byte_string)
+        Message.new(
+          '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]
+        )
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_factory.rb

@@ -1,75 +1,75 @@
-# 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 'erubis'
-require_relative 'message'
-
-module WinRM
-  module PSRP
-    # Creates WinRM::PSRP::Message instances for various PSRP messages
-    class MessageFactory
-      class << self
-        # Creates a new session capability PSRP message.
-        # @param runspace_pool_id [String] The UUID of the remote shell/runspace pool.
-        def session_capability_message(runspace_pool_id)
-          Message.new(
-            runspace_pool_id,
-            Message::MESSAGE_TYPES[:session_capability],
-            render('session_capability')
-          )
-        end
-
-        # Creates a new init runspace pool PSRP message.
-        # @param runspace_pool_id [String] The UUID of the remote shell/runspace pool.
-        def init_runspace_pool_message(runspace_pool_id)
-          Message.new(
-            runspace_pool_id,
-            Message::MESSAGE_TYPES[:init_runspacepool],
-            render('init_runspace_pool')
-          )
-        end
-
-        # Creates a new PSRP message that creates pipline to execute a command.
-        # @param runspace_pool_id [String] The UUID of the remote shell/runspace pool.
-        # @param pipeline_id [String] The UUID to correlate the command/pipeline
-        # response.
-        # @param command [String] The command passed to Invoke-Expression.
-        def create_pipeline_message(runspace_pool_id, pipeline_id, command)
-          Message.new(
-            runspace_pool_id,
-            Message::MESSAGE_TYPES[:create_pipeline],
-            render('create_pipeline', command: command.encode(xml: :text)),
-            pipeline_id
-          )
-        end
-
-        private
-
-        # Renders the specified template with the given context
-        # @param template [String] The base filename of the PSRP message template.
-        # @param context [Hash] Any options required for rendering the template.
-        # @return [String] The rendered XML PSRP message.
-        # @api private
-        def render(template, context = nil)
-          template_path = File.expand_path(
-            "#{File.dirname(__FILE__)}/#{template}.xml.erb")
-          template = File.read(template_path)
-          Erubis::Eruby.new(template).result(context)
-        end
-      end
-    end
-  end
-end
+# 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 'erubis'
+require_relative 'message'
+
+module WinRM
+  module PSRP
+    # Creates WinRM::PSRP::Message instances for various PSRP messages
+    class MessageFactory
+      class << self
+        # Creates a new session capability PSRP message.
+        # @param runspace_pool_id [String] The UUID of the remote shell/runspace pool.
+        def session_capability_message(runspace_pool_id)
+          Message.new(
+            runspace_pool_id,
+            Message::MESSAGE_TYPES[:session_capability],
+            render('session_capability')
+          )
+        end
+
+        # Creates a new init runspace pool PSRP message.
+        # @param runspace_pool_id [String] The UUID of the remote shell/runspace pool.
+        def init_runspace_pool_message(runspace_pool_id)
+          Message.new(
+            runspace_pool_id,
+            Message::MESSAGE_TYPES[:init_runspacepool],
+            render('init_runspace_pool')
+          )
+        end
+
+        # Creates a new PSRP message that creates pipline to execute a command.
+        # @param runspace_pool_id [String] The UUID of the remote shell/runspace pool.
+        # @param pipeline_id [String] The UUID to correlate the command/pipeline
+        # response.
+        # @param command [String] The command passed to Invoke-Expression.
+        def create_pipeline_message(runspace_pool_id, pipeline_id, command)
+          Message.new(
+            runspace_pool_id,
+            Message::MESSAGE_TYPES[:create_pipeline],
+            render('create_pipeline', command: command.encode(xml: :text)),
+            pipeline_id
+          )
+        end
+
+        private
+
+        # Renders the specified template with the given context
+        # @param template [String] The base filename of the PSRP message template.
+        # @param context [Hash] Any options required for rendering the template.
+        # @return [String] The rendered XML PSRP message.
+        # @api private
+        def render(template, context = nil)
+          template_path = File.expand_path(
+            "#{File.dirname(__FILE__)}/#{template}.xml.erb")
+          template = File.read(template_path)
+          Erubis::Eruby.new(template).result(context)
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_fragmenter.rb

@@ -1,60 +1,60 @@
-# 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_relative 'fragment'
-
-module WinRM
-  # PowerShell Remoting Protcol module
-  module PSRP
-    # PowerShell Remoting Protocol message fragmenter.
-    class MessageFragmenter
-      DEFAULT_BLOB_LENGTH = 32_768
-
-      def initialize(max_blob_length = DEFAULT_BLOB_LENGTH)
-        @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
-        message_bytes = message.bytes
-        bytes_fragmented = 0
-        fragment_id = 0
-        fragment = nil
-
-        while bytes_fragmented < message_bytes.length
-          last_byte = bytes_fragmented + max_blob_length
-          last_byte = message_bytes.length if last_byte > message_bytes.length
-          fragment = Fragment.new(
-            object_id,
-            message.bytes[bytes_fragmented..last_byte - 1],
-            fragment_id,
-            bytes_fragmented == 0,
-            last_byte == message_bytes.length
-          )
-          fragment_id += 1
-          bytes_fragmented = last_byte
-          yield fragment if block_given?
-        end
-
-        fragment
-      end
-    end
-  end
-end
+# 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_relative 'fragment'
+
+module WinRM
+  # PowerShell Remoting Protcol module
+  module PSRP
+    # PowerShell Remoting Protocol message fragmenter.
+    class MessageFragmenter
+      DEFAULT_BLOB_LENGTH = 32_768
+
+      def initialize(max_blob_length = DEFAULT_BLOB_LENGTH)
+        @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
+        message_bytes = message.bytes
+        bytes_fragmented = 0
+        fragment_id = 0
+        fragment = nil
+
+        while bytes_fragmented < message_bytes.length
+          last_byte = bytes_fragmented + max_blob_length
+          last_byte = message_bytes.length if last_byte > message_bytes.length
+          fragment = Fragment.new(
+            object_id,
+            message.bytes[bytes_fragmented..last_byte - 1],
+            fragment_id,
+            bytes_fragmented == 0,
+            last_byte == message_bytes.length
+          )
+          fragment_id += 1
+          bytes_fragmented = last_byte
+          yield fragment if block_given?
+        end
+
+        fragment
+      end
+    end
+  end
+end

data/lib/winrm/psrp/powershell_output_decoder.rb

@@ -1,139 +1,144 @@
-# -*- 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
-          Regexp.last_match[1].hex.chr
-        end
-      end
-    end
-  end
-end
+# -*- 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