chef-winrm 2.3.10

data/lib/winrm/psrp/message_data/error_record.rb

@@ -0,0 +1,68 @@
+# 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.
+
+module WinRM
+  module PSRP
+    module MessageData
+      # error record message type
+      class ErrorRecord < Base
+        def exception
+          @exception ||= property_hash('Exception')
+        end
+
+        def fully_qualified_error_id
+          @fully_qualified_error_id ||= string_prop('FullyQualifiedErrorId')
+        end
+
+        def invocation_info
+          @invocation_info ||= property_hash('InvocationInfo')
+        end
+
+        def error_category_message
+          @error_category_message ||= string_prop('ErrorCategory_Message')
+        end
+
+        def error_details_script_stack_trace
+          @error_details_script_stack_trace ||= string_prop('ErrorDetails_ScriptStackTrace')
+        end
+
+        def doc
+          @doc ||= REXML::Document.new(raw)
+        end
+
+        def string_prop(prop_name)
+          prop = REXML::XPath.first(doc, "//*[@N='#{prop_name}']")
+          prop.text if prop
+        end
+
+        def property_hash(prop_name)
+          prop_nodes = REXML::XPath.first(doc, "//*[@N='#{prop_name}']/Props")
+          return {} if prop_nodes.nil?
+
+          prop_nodes.elements.each_with_object({}) do |node, props|
+            name = node.attributes['N']
+            props[underscore(name).to_sym] = node.text if node.text
+          end
+        end
+
+        def underscore(camel)
+          camel.gsub(/::/, '/')
+               .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+               .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+               .tr('-', '_').downcase
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data/pipeline_host_call.rb

@@ -0,0 +1,30 @@
+# 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.
+
+module WinRM
+  module PSRP
+    module MessageData
+      # pipeline host call message type
+      class PipelineHostCall < Base
+        def method_identifier
+          clixml[:obj][0][:to_string]
+        end
+
+        def method_parameters
+          clixml[:obj][1][:lst]
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data/pipeline_output.rb

@@ -0,0 +1,48 @@
+# 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 'rexml/document' unless defined?(REXML::Document)
+
+module WinRM
+  module PSRP
+    module MessageData
+      # Handles decoding a raw powershell output response
+      class PipelineOutput < Base
+        def output
+          extract_out_string(remove_bom(raw.force_encoding('utf-8')))
+        end
+
+        private
+
+        def extract_out_string(text)
+          doc = REXML::Document.new(text)
+          doc.root.get_elements('//S').map do |node|
+            text = ''
+            if node.text
+              text << node.text.gsub(/(_x\h\h\h\h_)+/) do |match|
+                match.scan(/_x(\h\h\h\h)_/).flatten.map(&:hex)
+                     .pack('S*').force_encoding('utf-16le').encode('utf-8')
+              end.chomp
+            end
+            text << "\r\n"
+          end.join
+        end
+
+        def remove_bom(text)
+          text.sub("\xEF\xBB\xBF", '')
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data/pipeline_state.rb

@@ -0,0 +1,38 @@
+# 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.
+
+module WinRM
+  module PSRP
+    module MessageData
+      # pipeline state message type
+      class PipelineState < Base
+        NOT_STARTED = 0
+        RUNNING = 1
+        STOPPING = 2
+        STOPPED = 3
+        COMPLETED = 4
+        FAILED = 5
+        DISCONNECTED = 6
+
+        def pipeline_state
+          clixml[:i32].to_i
+        end
+
+        def exception_as_error_record
+          @exception_as_error_record ||= ErrorRecord.new(raw) if pipeline_state == FAILED
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data/runspacepool_host_call.rb

@@ -0,0 +1,30 @@
+# 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.
+
+module WinRM
+  module PSRP
+    module MessageData
+      # runspace pool host call message type
+      class RunspacepoolHostCall < Base
+        def method_identifier
+          clixml[:obj][0][:to_string]
+        end
+
+        def method_parameters
+          clixml[:obj][1][:lst]
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data/runspacepool_state.rb

@@ -0,0 +1,37 @@
+# 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.
+
+module WinRM
+  module PSRP
+    module MessageData
+      # runspace pool state message type
+      class RunspacepoolState < Base
+        BEFORE_OPEN = 0
+        OPENING = 1
+        OPENED = 2
+        CLOSED = 3
+        CLOSING = 4
+        BROKEN = 5
+        NEGOTIATION_SENT = 6
+        NEGOTIATION_SUCCEEDED = 7
+        CONNECTING = 8
+        DISCONNECTED = 9
+
+        def runspace_state
+          clixml[:i32].to_i
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data/session_capability.rb

@@ -0,0 +1,34 @@
+# 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.
+
+module WinRM
+  module PSRP
+    module MessageData
+      # session capability message type
+      class SessionCapability < Base
+        def protocol_version
+          clixml[:version].select { |v| v.attributes['N'] == 'protocolversion' }.first
+        end
+
+        def ps_version
+          clixml[:version].select { |v| v.attributes['N'] == 'PSVersion' }.first
+        end
+
+        def serialization_version
+          clixml[:version].select { |v| v.attributes['N'] == 'SerializationVersion' }.first
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_data.rb

@@ -0,0 +1,40 @@
+# 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 'message_data/base'
+require_relative 'message_data/error_record'
+require_relative 'message_data/pipeline_output'
+require_relative 'message_data/pipeline_host_call'
+require_relative 'message_data/pipeline_state'
+require_relative 'message_data/runspacepool_host_call'
+require_relative 'message_data/runspacepool_state'
+require_relative 'message_data/session_capability'
+
+module WinRM
+  # PowerShell Remoting Protcol module
+  module PSRP
+    # PowerShell Remoting Protocol message data.
+    module MessageData
+      def self.parse(message)
+        type_key = WinRM::PSRP::Message::MESSAGE_TYPES.key(message.type)
+        type = camelize(type_key.to_s).to_sym
+        const_get(type).new(message.data) if MessageData.constants.include?(type)
+      end
+
+      def self.camelize(underscore)
+        underscore.split('_').collect(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_defragmenter.rb

@@ -0,0 +1,62 @@
+# 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
+
+        # 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*'))
+        end
+        # rubocop:enable Style/GuardClause
+      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

@@ -0,0 +1,86 @@
+# 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 'erubi'
+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)
+          case context
+          when Hash
+            b = binding
+            locals = context.collect { |k, _| "#{k} = context[#{k.inspect}]; " }
+            b.eval(locals.join)
+          when Binding
+            b = context
+          when NilClass
+            b = binding
+          else
+            raise ArgumentError
+          end
+          b.eval(Erubi::Engine.new(template).src)
+        end
+      end
+    end
+  end
+end

data/lib/winrm/psrp/message_fragmenter.rb

@@ -0,0 +1,58 @@
+# 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.zero?,
+            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

@@ -0,0 +1,142 @@
+# 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